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

pkce-hook

v1.0.3

Published

Zero dependency authorization Code Flow with PKCE

Downloads

59

Readme

PKCE React Auth Library

Zero dependency authorization Code Flow with PKCE.

This library provides a simple and easy-to-use React hook for implementing PKCE (Proof Key for Code Exchange) authentication with an OAuth2 server.

Installation

To install the library, run:

npm install pkce-hook

or

yarn add pkce-hook

Usage

The library exposes an AuthProvider component that wraps your app and provides the useAuthService hook for authenticating with an OAuth2 server using the PKCE flow.

Here's an example of how to use the AuthProvider and useAuthService:

import React from "react";
import { AuthProvider, useAuthService } from "pkce-hook";

function App() {
  const authService = useAuthService();

  // Render your app...
}

export default function WrappedApp() {
  const authOptions = {
    authorizeEndpoint: "AUTHORIZATION_SERVER_LOGIN_URL",
    tokenEndpoint: "AUTHORIZATION_SERVER_TOKEN_URL",
    logoutEndpoint: "AUTHORIZATION_SERVER_LOGOUT_URL",
    autoRefresh: true,
    provider: "AUTHORIZATION_SERVER_BASE_URL",
    clientId: "YOUR_CLIENT_ID",
    redirectUri: "YOUR_REDIRECT_URI",
    scopes: ["openid", "profile", "email"],
    namespace: "APP_NAME",
  };

  return (
    <AuthProvider authOptions={authOptions}>
      <App />
    </AuthProvider>
  );
}

AuthProvider

In the example above, the AuthProvider component is wrapping the App component and providing the useAuthService hook.

The authOptions prop is required and should be an object containing the required properties provided by your OAuth2 server:

  • provider
  • clientId
  • redirectUri
  • scope

As well as optional properties:

  • authorizeEndpoint
  • tokenEndpoint
  • logoutEndpoint
  • autoRefresh
  • namespace

namespace config is useful in case of multiple micro-frontend apps are using different authorization mechanisms and have conflicting keys in local storage.

useAuthService

The useAuthService hook returns an object with the following properties:

  • isAuthenticated: A boolean indicating whether the user is authenticated.
  • isPending: A boolean indicating whether authentication is in progress.
  • authState: The authentication tokens returned by the OAuth2 server.
  • login: A function to initiate the PKCE flow and authenticate the user.
  • logout: A function to log the user out and clear the access and refresh tokens.

You can use these properties and functions to authenticate the user, access protected resources, and manage the user's authentication state.