persona

persona-verify

The official javascript client library for the Persona API.

Table of Contents

• persona-verify
  • Install
  • Documentation
  • Getting Started
  • Contributing
  • License

Install

npm install persona

Documentation

The module provides a client for the Persona embedded flow. For complete information about the API, head to the docs.

Getting Started

To open the flow you must create a Client object.

const Persona = require('persona');
const client: Client = new Persona.Client({
  // This refers to a production demo template owned by Persona
  templateId: 'persona-production_e1de83bf-e29f-48bb-9dae-568479b9edda',
  onLoad: () => client.open(),
  onStart: (inquiryId: string) => console.log(inquiryId),
  onComplete: (inquiryId: string, scopes: { [key: string]: string }) => console.log('onComplete'),
});

Contributing

Please see Contributing for guidelines and instructions for local development.

Releasing

Run the following command to generate changelogs and to bump semver to an appropriate value based on changes. Note that the suggested semver will only analyze commits using conventional-commits format.

yarn standard-version

Create a release branch using release/v*.*.* using the proper semver. This will automatically publish to NPM and our CDN.

NPM Auth

In order to publish to NPM, we've generated a token using npm token create --cidr=18.205.93.0/25,18.234.32.128/25,13.52.5.0/25. The --cidr list corresponds to Bitbucket's IPv4 CIDR list.

This CIDR list comes from: https://confluence.atlassian.com/bitbucket/what-are-the-bitbucket-cloud-ip-addresses-i-should-use-to-configure-my-corporate-firewall-343343385.htl

License

MIT