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

next-middle-api

v0.0.7

Published

Tools to help with nextjs API routes

Downloads

3

Readme

tests

next-middle-api

A NextJS API route middleware which supports the features listed below

Features

Available plugins

Route definitions for HTTP methods

Create route handlers for http methods

// pages/api/hello.ts
import type { NextApiRequest, NextApiResponse } from 'next'
import { createHandlers, PerRequestContext } from 'next-middle-api'

export default createHandlers({
  get: { // http methods e.g. post, get, patch, delete
    handler: async (req, res) => {
      res.status(200).json({name: 'hello'})
    }
  }
});

Middleware

Use middlewares to create reusable dependencies for the handlers and optional clean up. The cleanup callback will be called even if any failures take place. This comes in handy when you are dealing things like connections or db transactions.

// pages/api/hello.ts
import type { NextApiRequest, NextApiResponse } from 'next'
import { createHandlers, PerRequestContext } from 'next-middle-api'

async function closeConnection(value: unknown) {
  // close your connection
  console.log(`Disposing ${value}`);
}

function createConnection(req: NextApiRequest, res: NextApiResponse, context: PerRequestContext, next: () => Promise<void>): Promise<void> {
  // create your connection or transaction
  context.addItem('test', 'db connection', closeConnection);
  return next();
}

function commitOrRollbackTransaction(req: NextApiRequest, res: NextApiResponse, context: PerRequestContext, next: () => Promise<void>): Promise<void> {
  // check the response to decide to commit or rollback 
  const connection = context.getItem('test');
  console.log(`post hook response code was ${res.statusCode}`);
  return next();
}

export default createHandlers({
  get: {
    handler: async (req, res, context) => {
      res.status(200).json({name: context.getItem('test')})
    },
    preHooks: [createConnection],
    postHooks: [commitOrRollbackTransaction]
  }
});

Use middleware to intercept the call

// pages/api/hello.ts
import type { NextApiRequest, NextApiResponse } from 'next'
import { createHandlers, PerRequestContext } from 'next-middle-api'

async function setFromMiddleware(req: NextApiRequest, res: NextApiResponse, context: PerRequestContext, next: () => Promise<void>): Promise<void> {
  res.status(401).json({message: 'you are not authorised'})
}

export default createHandlers({
  get: {
    handler: async (req, res, context) => {
      res.status(200).json({name: 'this will not be called'})
    },
    preHooks: [setFromMiddleware]
  }
});

Global error handling

Define a function to handle an error in case of an error.

import type { NextApiRequest, NextApiResponse } from 'next'
import { createHandlers, HandlerOptions, PerRequestContext } from 'next-middle-api'


const opts: HandlerOptions = {
  errorHandler(error: unknown, req: NextApiRequest, res: NextApiResponse, context: PerRequestContext): Promise<void> {
    res.status(503).json({error: (error as Error).message})
  }
};

export default createHandlers({
  get: {
    handler: async (req, res, context) => {
      throw new Error('something fell apart');
    },
  }
}, opts);

Custom 404 Response

import { createHandlers, HandlerOptions } from 'next-middle-api';

const opts: HandlerOptions = {
  handlerMissingResponse() {
    return {message: 'my custom 404 message'}
  }
};

export default createHandlers({
  post: {
    handler: async (req, res) => {
      res.status(200).json({message: 'This was a post'})
    }
  },
}, opts);

Chaining Strategies

This is to customize how you want the chain to behave on error. By default, on error the chain stops executing.

Out of the box the supported strategies are:

  • Stop at first error in the chain
    • It will just use the errorHandler option that was passed which by default bubbles the error to the root.
  • Execute all even on error
    • It will execute all the middlewares and route handler even on error.
    • You need to make sure that you handle the error and return an appropriate response else it will keep waiting.
    • The context firstError prop has the first error that occurred.
    • The errors prop will give all the errors.
  • Execute on error but skip the handler
    • It will execute all the middlewares but skip the route handler on error.
    • You need to make sure that you handle the error and return an appropriate response else it will keep waiting.
    • The context firstError prop has the first error that occurred.
    • The errors prop will give all the errors.

You can choose to implement your own custom strategy by implementing IChainingStrategy and using it instead

The example below shows how to change the chaining strategy.

import { HandlerOptions, ApiRouteMiddleware, createHandlers, ChainingStrategies } from 'next-middle-api';

const alwaysThrowError: ApiRouteMiddleware = async () => {
  throw new Error('some new error');
};

const returnErrorMessage: ApiRouteMiddleware = async (req, res, context, next) => {
  if (!context.hasError) return next();
  const message = (context.firstError as any).message;
  res.status(500).json({message: `${message} was found later down stream`});
  await next();
};

const opts: HandlerOptions = {
  chainingStrategy: ChainingStrategies.ContinueButSkipHandlerOnError
};

export default createHandlers({
  get: {
    handler: async (req, res) => {
      res.status(200).json({message: 'this handler will not execute'});
    },
    preHooks: [alwaysThrowError],
    postHooks: [returnErrorMessage]
  }
}, opts);

License

MIT License

Copyright (c) 2022 Mohnish Chowdhury

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.