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

@sassoftware/sas-auth-browser

v0.2.0

Published

The sas-auth-browser package provides an API that allows for an application or web page to ensure that a user is authenticated before making SAS API calls or using SAS web components.

Downloads

34

Readme

SAS Authentication Library for the Browser

The sas-auth-browser package provides an API that allows for an application or web page to ensure that a user is authenticated before making SAS API calls or using SAS web components. Currently only cookie-based authentication is supported.

Prerequisites

In order to successfully make browser based REST calls to SAS Viya endpoints using cookies, you will need to enable CORS, Cross-site cookies and CSRF web security settings. For more information, see the SAS® Visual Analytics SDK SAS Viya setup guide.

Installation

npm install @sassoftware/sas-auth-browser

CDN

<script
  async
  src="https://cdn.developer.sas.com/packages/sas-auth-browser/latest/dist/index.min.js"
></script>

Usage

A simple example that uses sas-auth-browser is provided in the examples directory.

Additionally, before a rest API call is made to the SAS Viya server, you should first check to see if the cookie session is still valid.

const sasAuthInstance = sasAuthBrowser.createCookieAuthenticationCredential({
  url,
});
async function callViyaApi() {
  try {
    await sasAuthInstance.checkAuthenticated();
  } catch {
    // Note: If the user closes the popup an uncaught exception will occur.
    await sasAuthInstance.loginPopup();
  }
  // Start making rest calls!
}

API

sasAuthBrowser.createCookieAuthenticationCredential(configuration): CookieAuthenticationCredential

Creates a new CookieAuthenticationCredential instance. This function is used when importing sas-basic-auth globally.

See: CDN

  • configuration: object
    • url: string The URL of the SAS Viya server that you are authenticating with.
    • guest: boolean Automatically log in as a guest, if no user session is found.
      • default value: false

CookieAuthenticationCredential

The CookieAuthenticationCredential class provides functions to check the authentication status of a given endpoint

new CookieAuthenticationCredential(configuration)

  • configuration: object
    • url: string The URL of the SAS Viya server that you are authenticating with.
    • guest: boolean Automatically log in as a guest, if no user session is found.
      • default value: false

Methods

checkAuthenticated(): Promise<void>

Checks to see if any user is authenticated.

rejects: If no user is authenticated.

loginPopup(): Promise<void>

Launches a popup window that navigates to the authentication endpoint and allows the user to login.

rejects: When login fails (for example: user closes the popup).

logout(): Promise<void>

Makes an endpoint call to the SAS Viya server that ends the cookie based browser session.

rejects: When sign out fails.

invalidateCache()

If checkAuthenticated has already been called, a cached value may be returned the next time. This is done to reduce the number of potential service calls needed when making multiple API calls. Calling invalidateCache will force checkAuthenticated to re-validate the next time it is called. This is not needed for most use cases.

Contributing

sas-auth-browser is not open for external contributions at this time.

License

This package is licensed under this commercial license.