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

@vesselapi/client-sdk

v0.1.13

Published

Vessel API Client SDK

Downloads

115

Readme

About

Vessel is an embedded integrations OS making it easy to provide native GTM (go to market) integrations for Salesforce, HubSpot, Outreach, Ringcentral, and much more. Use our Unified API, Actions API, or Managed ETL to pull and push data to these end platforms in a variety of ways and schemas.

For more information including a more in-depth tutorial and documentation visit docs.vessel.dev

Installing

npm install @vesselapi/react-vessel-link
yarn add @vesselapi/react-vessel-link

Usage

When the Vessel client SDK is instantiated, a hidden modal iframe is attached to your application. When opened, the modal iframe will show the authentication flow for a given integration to your user.

Default Usage

There are several important configuration options when opening the modal. The first is the integrationId which is required and will select the integration to open. To get a dynamic list of the integrations we support, including their integrationId, name, and iconURI you can call the Integrations List endpoint.

export default function App() {
  const { open } = Vessel(...);

  return (
    <button
      onClick={() =>
        open({
          integrationId: 'outreach',
          getSessionToken: () => api.get('/session-token'),
        })
      }
    >
      Connect Outreach
    </button>
  );
}

Change Auth Type

Vessel will use the default authentication method if none is provided. However, if an integration supports multiple authentication methods - say API key and OAuth - you can configure the modal to use one or the other by utilizing the authType property. For a list of supported auth types per-integration, please check the Platform object in the integrations library.

export default function App() {
  const { open } = Vessel(...);

  return (
    <button
      onClick={() =>
        open({
          authType: 'apiKey',
          integrationId: 'outreach',
          getSessionToken: () => api.get('/session-token'),
        })
      }
    >
      Connect Outreach
    </button>
  );
}

Change OAuth app used

If the integration requires OAuth authentication and Vessel provides a pre-approved default application, that app will be used to authenticate your user.

However, if your plan supports it, you can configure a custom OAuth application that you've created to be used when authenticating your user. To do so, please follow the manage oauth apps guide. Once you've retrieved an oauthAppId you can pass it to the modal open.

export default function App() {
  const { open } = Vessel(...);

  return (
    <button
      onClick={() =>
        open({
          oauthAppId: '....',
          integrationId: 'outreach',
          getSessionToken: () => api.get('/session-token'),
        })
      }
    >
      Connect Outreach
    </button>
  );
}

Issues/Questions

Contact us at [email protected]