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

@trypanacea/sdk

v0.0.20

Published

The Panacea SDK enables developers to seamlessly integrate the Panacea live chat widget into their web applications. It provides tools for initializing chat sessions, customizing widget behavior, and managing user interactions—all with minimal setup.

Downloads

1,241

Readme

Panacea SDK

The Panacea SDK enables developers to seamlessly integrate the Panacea live chat widget into their web applications. It provides tools for initializing chat sessions, customizing widget behavior, and managing user interactions—all with minimal setup.

Features

  • Easy-to-integrate chat widget
  • Customizable launcher button
  • Supports shadow DOM for CSS isolation
  • API-driven session creation
  • Lightweight and developer-friendly

Installation

Install the Panacea SDK via npm:

npm install @trypanacea/sdk

Usage

Basic Setup

Import and initialize the SDK in your application:

import { PanaceaSDK } from "@trypanacea/sdk";

PanaceaSDK.initPanacea({
  appKey: "your-app-key",       // Replace with your app key
  apiKey: "your-api-key",       // Replace with your API key
  settings: {
    userId: "12345",            // Optional: Unique user ID
    firstName: "John",          // Optional: User's first name
    lastName: "Doe",            // Optional: User's last name
    email: "[email protected]", // Optional: User's email
    actionColor: "#3498db",     // Optional: Button color
    backgroundColor: "#ffffff", // Optional: Widget background color
    region: "us",               // Optional: Default region (us, eu, ap)
  },
});

Customizing the Launcher Button

You can hide the default launcher and use a custom element:

PanaceaSDK.initPanacea({
  appKey: "your-app-key",
  apiKey: "your-api-key",
  settings: {
    customLauncherSelector: "#custom-launcher",
    hideDefaultLauncher: true,
  },
});

In your HTML:

<button id="custom-launcher">Start Chat</button>

Example with React

Here's how to integrate the SDK in a React component:

import { useEffect } from "react";
import { PanaceaSDK } from "@trypanacea/sdk";

const ChatWidget = () => {
  useEffect(() => {
    PanaceaSDK.initPanacea({
      appKey: "your-app-key",
      apiKey: "your-api-key",
      settings: {
        firstName: "Jane",
        email: "[email protected]",
      },
    });
  }, []);

  return null;
};

export default ChatWidget;

API Reference

initPanacea({ appKey, apiKey, settings })

  • appKey (string): Your app's unique identifier. Required.
  • apiKey (string): API key for authentication. Required.
  • settings (object): Configuration options:
    • userId (string): User ID for the session.
    • firstName (string): User's first name.
    • lastName (string): User's last name.
    • email (string): User's email.
    • avatar (string): URL to the user's avatar image.
    • customLauncherSelector (string): CSS selector for a custom launcher.
    • hideDefaultLauncher (boolean): Hide the default launcher button.
    • actionColor (string): Color for interactive elements.
    • backgroundColor (string): Chat widget background color.
    • region (string): Server region (us, eu, ap).

Development

Running Tests

Run the unit tests to ensure everything is working correctly:

npm test

Building the Package

Compile the TypeScript code:

npm run build

Contributing

Contributions are welcome! Please follow these steps:

  1. Fork the repository.
  2. Create a new branch: git checkout -b feature/your-feature
  3. Make your changes and commit them: git commit -m "Add your feature"
  4. Push to your branch: git push origin feature/your-feature
  5. Submit a pull request.

License

This package is licensed under the MIT License.

Support

If you encounter issues or have questions, please open an issue in the GitHub repository.