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

@rapidnetworks/sam

v2.0.2

Published

Authentication Microservice for working with splynx in all Rapid Networks Projects

Downloads

1

Readme

S.A.M - Splynx Authentication Module

https://nodei.co/npm/@rapidnetworks/sam.png?mini=true code style: prettier


About

Wow, I am really getting tired of trying to implement the authentication for Splynx everytime I start a new project.

This module is built for ongoing projects involving our (at time of writing) ISP billing software: Splynx. This service uses the v2 API spec for communicating with the Splynx API.

Install :electric_plug:

npm i @rapidnetworks/sam

This module includes its own type definitions

Usage :rocket:

This package exposes the 4 different API token types, each having a TTL of 30 minutes. This is just a basic overview of usage of the package, however you can view the official documentation to see the implementation and required information here

1. API Token:

import { apiToken } from '@rapidnetworks/sam';

const token = apiToken(url: string, api_key: string, api_secret: string);

2. Customer Token:

import { customerToken } from '@rapidnetworks/sam';

const token = customerToken(url: string, customer_login: string, customer_password: string);

3. Administrator Token:

import { adminToken } from '@rapidnetworks/sam';

const token = adminToken(url: string, admin_login: string, admin_password: string, 2fa_code?: string, 2fa_fingerprint?: string);

4. Session Token:

import { sessionToken } from '@rapidnetworks/sam';

const token = sessionToken(url: string, session_id: string);

All of these tokens are part of a base Authentication token class, allowing full access to the following methods:

1. .refresh(): Promise<void>

This method refreshes the token and updates the token object with the new `access_token` value

2. .delete(): Promise<void>

This method invalidates the `access_token` value, blacklisting it for further use.

The full token object has the following properties:

class AuthorizationToken {
  private url: string;
  public readonly access_token: string;
  public readonly refresh_token: string;
  public readonly access_token_expiration: number;
  public readonly refresh_token_expiration: number;
  public readonly permissions: Record<string, Record<string, string>>;
}