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

@keyro/kl-sdk

v1.0.6

Published

Keyro Login SDK provides access to every KL public features out of the box.

Downloads

13

Readme

Keyro Login SDK

Keyro Login SDK provides access to every KL public features out of the box.

Install

yarn add '@keyro/kl-sdk'

Missing anything ?

We are still on a freshy-alpha release. As a keyro team member, if you need something lemme know

Usage

import KLSDK from '@keyro/kl-sdk'

/**
 * Create an instance of the SDK and customize it with the following. Default configuration is hard-coded and 
 * rely on the definition of `production` option. Overriding both keyroLoginUrl and accessManagerUrl makes 
 * `production` value negligible.
 *    * `production` : use it to change default configuration.
 *    * `keyroLoginUrl` : override the default url
 *    * `accessManagerUrl` : override the default url
 */
const KL = KLSDK({
  production: true, // Default: false
  keyroLoginUrl: 'https://login-dev.keyro.fr',
  accessManagerUrl: 'https://api.login.keyro.fr'
})

/**
 * Takes you to the login page depending on your instance config.
 * @param {String} origin Url you want to be redirected after login
 */
KL.signin(`${window.location.origin}/auth/callback`)

/**
 * Takes you to the signout page depending on your instance config.
 * @param {String} origin Url you want to be redirected after login
 */
KL.signout(`${window.location.origin}/byebye`)

/**
 * Authentication expire after one hour. 15 minutes before expiration,
 * `needRefresh` will encourage a refresh.
 * 
 * Determine if you need to refresh your tokens
 * @returns {Boolean}
 */
KL.needRefresh(store.session)

/**
 * After a successful signin, Keyro Login will redirect to the origin
 * you provide in `signin` method with a bunch of url encoded params.
 * Using function `signinCallback` allow you to turn it into a proper session entity.
 * 
 * Take a queryParams object and format it into a session entity
 * @returns {Object} Session
 */
KL.signinCallback(this.$route.query)

/**
 * Invalidate all tokens of your session causing your device to
 * disconnet from all Keyro apps.
 * @param {Object} session A session entity
 */
KL.globalSignout(store.session)

/**
 * Entrust your session to be valid against the OAUTH Authorization Provider
 * Of Keyro Login.
 * @param {Object} session A session entity
 * @returns {Boolean}
 */
KL.isSessionValid(store.session)

/**
 * While your refresh token hasn't expired, you can call this method to get a new
 * AccessToken and a new IdentityToken.
 * 
 * Provide an updated Session entity with a new Access and identity tokens.
 * @param {Object} session a Session entity
 * @returns {Object} Session Entity
 */
KL.refreshSession(session)

/**
 * A good way to ensure control over your credentials data is to entrust them as a Session entity.
 * @param {Object} data representing Session entity
 * @returns {Object} Session Entity
 */
KL.makeSession(data)

The session entity

To be a valid session entity a JSON structure must be of the following structure :

{
  "identityToken": "(Mandatory) string",
  "accessToken": "(Mandatory) string",
  "refreshToken": "(Mandatory) string",
  "expiresIn": "(At least one) seconds integer",
  "expiresAt": "(At least one) date string"
}

If you pass an expiresIn value, kl-sdk will parse it as an expiredAt for you.