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

@saasquatch/component-environment

v1.0.8

Published

Environment and contexts for SaaSquatch components

Downloads

289

Readme

Provides the environment for running SaaSquatch web components.

SaaSquatch web components can run in a number of different environments, including:

  • in a widget via squatch-js
  • in a microsite (portal)
  • in a mobile SDK (i.e. squatch-android)
  • in the admin portal

In each environment, a different set of context information about the tenant, user and program are provided, and the goal of this package is to normalize the differences in environments to provide a common API.

The environment is provided in a set of contexts through dom-context, which provides vanilla global context providers. They can be accessed through a raw ContextListener or via useDomContext in dom-context-hooks.

General environment

getEnvironment()

Get the environment type. The current possible values are: SquatchJS2, SquatchAndroid, SquatchPortal, SquatchAdmin or None.

isDemo()

Returns whether components should run in demo/preview mode.

getTenantAlias()

Get the current tenant alias.

getAppDomain()

Get the SaaSquatch app domain.

getEngagementMedium()

Get the current engagement medium. This is particularly important in widgets rendered by squatch-js for informing metadata about share link clicks.

User identity

The user identity context name is exported in a constant USER_CONTEXT_NAME. The current value can be retrieved with getUserIdentity() and set with setUserIdentity(identity).

Locale

The locale context name is exported in a constnat LOCALE_CONTEXT_NAME. The current value can be retrieved with getLocale() and set with setLocal(locale).

Program ID

The program ID context name is exported in a constant PROGRAM_CONTEXT_NAME. The current value can be retrieved with getProgramId() and set with setProgramId(programId).