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

copper-sdk

v0.8.0

Published

Copper App SDK

Downloads

68

Readme

Copper App SDK

npm

The javascript SDK provides client-side functionalities for adding embedded apps to the Copper web client.

The embedded app is an iframe embedded in the Copper web page. The display location of the iframe is configured in the embedded app's settings page.

Usage

Execute the following with your webpack/rollup/browserify etc.

yarn add copper-sdk
# or
npm install copper-sdk --save

Followed by:

import Copper from 'copper-sdk';
const sdk = Copper.init();

sdk.getContext()
  .then(({ context }) => {
    // do something with the context
  });

Use with CDN

copper-sdk is served with https://www.jsdelivr.com/package/npm/copper-sdk

<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/copper-sdk@latest/dist/copper-sdk.min.js"></script>
<script type="text/javascript">
var sdk = window.Copper.init();
sdk.getContext()
  .then(function (data) {
    var type = data.type; // person,lead,...
    var context = data.context;
    // do something with the context
  });
</script>

Development

Prerequisites

We recommend Node 18 or newer.

Confirm all packages have been installed. This project uses yarn for package management.

yarn

Developing SDK

## watch changes
yarn dev

## or run separately
yarn dev:es
yarn dev:commonjs

## build
yarn build

## test
yarn test
# or watch changes
yarn test:dev

## lint
yarn lint

FAQ

How do I use my local SDK instead of the npm one?

Execute yarn link inside this repository, then navigate over to the other repository and execute yarn link copper-sdk.

An alternative way would be to execute npm link path/to/copper-sdk in the repository.