ctjlewis/next-endpoint

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

// pages/api/getData.ts

interface GetDataArgs {
  a: number;
  b: number;
}

/**
 * Exporting allows you to call this from other API functions directly, e.g.
 * in your frontend via `import { getData } from ...`.
 */
export const getData: ApiFunction<GetDataArgs> = ({ a, b }) => {
  return {
    sum: Number(a) + Number(b);
  };
}

export default withEndpoint(getData);

Authentication

You can register an ApiAuthFunction to get access to the Auth0 session params. These functions can only run on the server.

// pages/api/updateUser.ts

/**
 * 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: ApiAuthFunction<UpdateUserArgs> = ({
  session,
  id,
  updates
}) => {
  if (isAdmin(session.user.sub)) {
    applyChangesToUser({ id, updates });
  }
}

/**
 * Will wrap with Auth0's `withAuthenticationRequired` and assert a valid 
 * session inside the handler, and accept data through POST requests instead of
 * via URL query params. 
 */
export default withAuthEndpoint(updateUser, { method: "POST" });

Google Analytics

With NEXT_PUBLIC_GA_MEASUREMENT_ID and GA_API_SECRET env vars set, endpoints will automatically send Google Analytics 4 events for endpoint calls using node-google-analytics.

You can also easily use the googleAnalytics(...) function within your endpoints to send additional custom events server-side.