@manifoldco/shadowcat

shadowcat

Invisible web component auth implementation of Manifold's PUMA <https://github.com/manifoldco/puma>

Usage

1. npm i @manifoldco/shadowcat
2. Import and register the manifold-oauth web component:

import { defineCustomElements } from '@manifoldco/shadowcat/dist/loader';

defineCustomElements(window);

1. Add the following code anywhere on your website/app to get an auth token:

<manifold-oauth oauth-url="[your-oauth-url]"></manifold-oauth>

1. Listen for the event tokenReceived:

document.addEventListener("tokenReceived", e => {
  console.log(e.detail); // received token
  // do stuff...
});

Dev Setup

1. npm install to install dependencies.
2. npm start to start the development server.
3. Go to localhost:3333. The development server will display a blank page.
4. Open the console. There will be a message/token logged.

Publish to npm

1. Add a git tag with the version number you want to publish.
   • For example, version 1 would be git tag v1.0.0.
2. Publish the version to npm by running npm run publish.
   • Ensure that you're logged into your npm account and have access to publish packages in the @manifoldco org when you do this.

Links

Code of Conduct | Contribution Guidelines