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

@bigcommerce/app-sdk-js

v1.0.0

Published

BigCommerce App JavaScript SDK

Downloads

8

Readme

BigCommerce App SDK

Overview

The BigCommerce (BC) JS SDK is a simple javascript library used to manage apps in the control panel. BC's JS SDK includes functionality to prevent users from being logged out of the control panel while using an app. Additionally, BC's JS SDK includes out of the box support for handling logout requests.

App Installation (Development)

  1. Copy the SDK locally
  2. Install necessary packages
    • cd app-sdk-js
    • npm install
  3. Create an NPM link
    • npm link
  4. Link your app's package to the SDK, e.g.

Usage

In its most basic form, the BigCommerce SDK is used to keep apps in sync with the control panel. This prevents users of an application from being logged out. To consume the SDK, it should be loaded at the top of an application; ideally, as part of the main index. This enables the SDK to properly communicate with the control panel by covering the entire application.

In your application's main index (or app) file, import the library:

import 'bigcommerce-app-sdk-js';

Next, initialize the SDK. This should be done in the first part of the application that has access to the window object. In React-based applications, including NextJS, this can be done inside of useEffect or componentDidMount (for class components).

window.bcAsyncInit = function() {
  Bigcommerce.init({
    onLogout: callback
  });
}

Finally, to add an additional layer of security, an onLogout callback can be passed. This callback will be hit if the user logs out of the control panel, including logging out from a separate tab. For example, the NextJS sample app calls an internal API which removes the user from the active session.