with-next-endpoint v0.3.1

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 }.

/**
 * Exporting allows you to call this from other API functions directly.
 */
export const getData: ApiFunction = ({ a, b }) => {
  return {
    sum: a + b;
  };
}

export default withEndpoint(getData);

Authentication

/**
 * Every function which relies on auth should accept a { session } param
 * containing the Auth0 session.
 * 
 * You can still import this from other API functions and use it directly,
 * simply pass the { session } param.
 */
export const updateUser: AuthApiFunction = ({ session, id, params }) => {
  if (isAdmin(session.user.sub)) {
    applyChangesToUser({ id, params });
  }
}

/**
 * Will wrap with Auth0's `withAuthenticationRequired` and assert a valid 
 * session inside the handler.
 */
export 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