With Next Endpoint

Easily turn simple functions into Next.js handlers. Includes withAuthEndpoint() for Auth0 authentication.

Example

Simple

A request to /api/getData?a=4&b=6 will return { sum: 10 }.

1/**
2 * Exporting allows you to call this from other API functions directly.
3 */
4export const getData: ApiFunction = ({ a, b }) => {
5  return {
6    sum: a + b;
7  };
8}
9
10export default withEndpoint(getData);

Authentication

1/**
2 * Every function which relies on auth should accept a { session } param
3 * containing the Auth0 session.
4 * 
5 * You can still import this from other API functions and use it directly,
6 * simply pass the { session } param.
7 */
8export const updateUser: AuthApiFunction = ({ session, id, params }) => {
9  if (isAdmin(session.user.sub)) {
10    applyChangesToUser({ id, params });
11  }
12}
13
14/**
15 * Will wrap with Auth0's `withAuthenticationRequired` and assert a valid 
16 * session inside the handler.
17 */
18export default withAuthEndpoint(updateUser);

Developing

This project is a tszip package written in TypeScript with the latest ESNext syntax in src/ and compiled to ES module output in dist/.

Editing

To watch for changes:

yarn dev

Building

To build the release package:

yarn build

Publishing

To compile the release build and publish to NPM:

yarn publish