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

router-access-plugin

v1.0.1

Published

Plugin to simplify access control to private pages

Downloads

1

Readme

This is a plugin for router5 allows you to set up private access for some pages by calling only 2 methods

methods

  • createPrivateAccess
  • checkAccess

First step (router)

import createRouter from 'router5';
import accessPlugin from "access-plugin-router";

const adminRoute =  { name: 'admin', path: '/admin' };
const moderatorRoute = { name: 'moderator', path: '/moderator' };
const homeRoute = { name: 'home', path: '/' };

const routes = [
  homeRoute,
  adminRoutes,
  moderatorRoutes,
]

const routeInstance = createRouter(routes)

router.usePlugin(accessPlugin());

/// first method
routeInstance.createPrivateAccess(adminRoutes, moderatorRoutes);

routeInstance.start();

createPrivateAccess method accepts any number of routes, iterates over their children recursively and marks each path as private

From this moment, router5 will not be able to go to private pages until we call the second plugin method

Next step (state)

import { routeInstance } from './router';

const state = {
    isHaveAccess: 'loading',
};

const getAccess = async () => {
    const response = await fetch('protectedUrl', {
      headers: {
        Authentication: 'secret'
      }
    });
    state.isHaveAccess = response.ok ? true : false;

   /// second method
   routeInstance.checkAccess(token);
};

if state.isHaveAccess === true, then access to private pages will be open, otherwise closed.

Additional Information

  • accessPlugin accepts an object with plugin settings
    • log displays information about the plugin operation to the console
    • navigateDefault allows you to specify the path where the user will be thrown instead of the default of route5 if the user tries to navigate to a private page while checkAccess is false
   type option = {
      log?: boolean;
      navigateDefault?: string;
   }
   router.usePlugin(accessPlugin(option))
  • checkAccess accepts a boolean value or a 'loading' string
    • if checkAccess contains 'loading', then the plugin will not redirect the user to the default page, but will deny access until a boolean value is received, use this if you want to leave the user the ability to go to private pages immediately from outside
  type key = boolean | 'loading';
  router.checkAccess(key);