https://github.com/qlaffont/next-protected-auth

Next.JS Protected auth plugin
https://github.com/qlaffont/next-protected-auth

authentication nextjs routes routing typescript

Last synced: about 2 months ago
JSON representation

Next.JS Protected auth plugin

• Host: GitHub
• URL: https://github.com/qlaffont/next-protected-auth
• Owner: qlaffont
• License: mit
• Created: 2022-09-20T12:01:28.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-10-29T22:14:02.000Z (about 2 months ago)
• Last Synced: 2024-10-30T00:40:05.466Z (about 2 months ago)
• Topics: authentication, nextjs, routes, routing, typescript
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/next-protected-auth
• Size: 1.2 MB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Maintainability](https://api.codeclimate.com/v1/badges/1c3d4f9f17d9514df0ec/maintainability)](https://codeclimate.com/github/qlaffont/next-protected-auth/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/1c3d4f9f17d9514df0ec/test_coverage)](https://codeclimate.com/github/qlaffont/next-protected-auth/test_coverage) ![npm](https://img.shields.io/npm/v/next-protected-auth) ![npm](https://img.shields.io/npm/dm/next-protected-auth) ![Snyk Vulnerabilities for npm package](https://img.shields.io/snyk/vulnerabilities/npm/next-protected-auth) ![NPM](https://img.shields.io/npm/l/next-protected-auth)

# Next Protected Auth

Add protected routes to Next.js. Old Owner: [@flexper](https://github.com/flexper)

## Usage

See example folder

## API

### NextAuthProtectedLogin

**Options**

| Field Name      | Type                             | Description                                                         |

| --------------- | -------------------------------- | ------------------------------------------------------------------- |

| callback        | VoidFunction / AsyncVoidFunction | Specify a callback after login (generally redirect to oauth portal) |

| authCallbackURL | string                           | Specify auth callback url in case of accessToken already exist      |

Return: React Component

### NextAuthProtectedLogout

**Options**

| Field Name  | Type                             | Description                                                                       |

| ----------- | -------------------------------- | --------------------------------------------------------------------------------- |

| preCallback | VoidFunction / AsyncVoidFunction | Specify a callback before logout (generally send to api that user want to logout) |

| callback    | VoidFunction / AsyncVoidFunction | Specify a callback after logout (generally redirect to home)                      |

Return: React Component

### NextAuthProtectedCallback

**Options**

| Field Name | Type                             | Description                                                                     |

| ---------- | -------------------------------- | ------------------------------------------------------------------------------- |

| callback   | VoidFunction / AsyncVoidFunction | Specify a callback after auth callback (generally redirect to protected routes) |

Return: React Component

### useNextAuthProtectedHandler

**Options**

| Field Name      | Type                                | Description                                                              |

| --------------- | ----------------------------------- | ------------------------------------------------------------------------ |

| publicURLs      | string[]                            | List of public URLs                                                      |

| loginURL        | string                              | Endpoint for login (ex: /auth/login)                                     |

| authCallbackURL | string                              | Endpoint for auth callback (ex: /auth)                                   |

| renewTokenFct   | (oldAccessToken?: string) => string | Function who will run to renew token (ex: refresh token)                 |

| verifyTokenFct  | (accessToken?: string) => string    | Function who test accessToken validity (ex: verify JWT token expiration) |

| allowNotFound   | boolean?                            | Allow to consult Not found pages in public                               |

Return: Hook who need to be use to pages/_app.tsx

### useNextAuthProtected

Return: {isConnected: boolean; setIsConnected: Dispatch} // User is connected

### getAndSaveAccessToken

**Options**

| Field Name    | Type                                                   | Description                                                  |

| ------------- | ------------------------------------------------------ | ------------------------------------------------------------ |

| renewTokenFct | (oldAccessToken?: string) => string OR Promise | Function who will run to renew token (ex: refresh token)  to |

| accessToken   | string                                                 | access token to save                                         |

Return: boolean (Token is saved)

### getAccessToken

Return: string  (Return access token)

### removeAccessToken

Return: void

## Maintain

This package use [TSdx](https://github.com/jaredpalmer/tsdx). Please check documentation to update this package.