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

@recidiviz/auth

v1.1.0

Published

Auth0-Powered Authentication Module

Downloads

2,412

Readme

Recidiviz Authentication Module

Auth0-powered authentication module for use within the web applications that make up the Recidiviz web platform.

Usage

This module contains two components:

| Component | Description | | -: | - | | AuthStore | a mobX data store (Defining data stores) that handles Auth0 authentication, authentication states, logout and token retrieval functionality | | AuthWall | a React functional component that wraps around any component that requires authentication before rendering - it accepts (as props) and displays the provided loading component, unauthorized page and email verification page based on authentication status and app state |

AuthStore

Initialize the AuthStore by providing it with { authSettings } (see Auth0ClientOptions):

const authStore = new AuthStore({ authSettings });

AuthWall

<AuthWall 
  authStore
  loading
  unauthorizedPage
  emailVerificationPage
  handleTargetUrl
>
  <ProtectedComponent />
</AuthWall>

| Required Props | Description | | -: | - | | authStore | initialized AuthStore | | loading | contents to render for loading page/state | | unauthorizedPage | contents to render for an unauthorized user logging in | | emailVerificationPage | contents to render for a user who has not verified their email address |

|             Optional Props | Description | | -: | - | | handleTargetUrl | handleTargetUrl: ((targetUrl: string) => void) | undefined runs a callback function, if provided, that will handle the Auth0 appState target URL |

Local Development

The component library can be developed directly alongside dependent projects via yalc.

Running yarn watch will rebuild the application bundle and publish it to yalc whenever you make changes. In the dependent project(s), there is a one-time step of running yalc add --link @recidiviz/auth (and yarn install) before starting the development server for that application; once this is done, your changes here should be picked up automatically and trigger a reload. Run yalc remove @recidiviz/auth to restore the project's dependencies to their previous state.

Module Scope

The package's main entrypoint is at src/index.ts.