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

react-native-pluggy-connect

v1.3.2

Published

Pluggy Connect SDK for React Native.

Downloads

277

Readme

React Native Pluggy Connect SDK

React Native bindings for our Pluggy Connect widget.

Setup

Using npm

npm install react-native-webview react-native-pluggy-connect

Using yarn

yarn add -S react-native-webview react-native-pluggy-connect

Usage

Please check out our Connect React Native quickstart repo for a fully-working example you can use to get started right away.

Typescript Support

This project was built using Typescript so all typings are natively built-in.

However, for up-to-date Pluggy API typings to work, you'll need to install pluggy-js in your project as well, either as a dev or prod dependency.

npm install pluggy-js

Oauth Support

To fully support Oauth you need to follow the following guide: https://docs.pluggy.ai/docs/oauth-support-guide

Configurations

The available configuration props are the following.

See our official Pluggy Connect widget documentation for more detailed information.

| Property | Description | Required? | Type | Default | | -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- | | connectToken | Your Pluggy Connect token, which will be used to access the API. | ✅ | string | N/A | | includeSandbox | Whether to display Sandbox connectors in the Connector selection step (not intended for production use) |  | boolean | false | | allowConnectInBackground | If true, Connect can be minimized by the user to continue the connection with the component hidden |  | boolean | false | | updateItem | Item id to update. If specified, the modal will display directly the credentials form of the item to be updated. |  | string | N/A | | connectorTypes | List of Connector Types. If defined, only Connectors of the specified connector types will be listed. |  | ConnectorType[] | N/A | | connectorIds | List of Connector IDs. If defined, only Connectors of the specified connector IDs will be listed. |  | number[] | N/A | | countries | List of country codes (ISO-3166-1 alpha 2 format). If defined, only Connectors of the specified countries will be listed. |  | CountryCode[] | N/A | | selectedConnectorId | If specified and the Connector is present, after accepting terms, the widget will navigate to this Connector login form directly, skipping connectors selection step. |  | number | N/A | | language | Language (2-letter ISO code string), used to display the widget. If not specified, or if the selected language is not supported, the default 'pt' will be used. |  | string | 'pt' | | theme | Theme to use for displaying the UI. Can be 'light' or 'dark'. Defaults to 'light' |  | 'light' | 'dark' | 'light' | | onSuccess | Function to execute when an Item has been created/updated successfully. |  | (data: { item: Item }) => void | Promise<void> | No op | | onError | Function to execute on a general error loading the widget, or when an Item creation/update status has not been successful. |  | (error: { message: string; data?: { item: Item } }) => void | Promise<void> | No op | | onOpen | Function to execute when the widget modal has been opened. |  | () => void | Promise<void> | No op | | onClose | Function to execute when the widget modal has been closed. |  | () => void | Promise<void> | No op | | onEvent | Function to execute to handle custom user interaction events. See the docs for more info. |  | Since v2.0.0: (payload: ConnectEventPayload) => void | Promise<void> Until 1.x: (event: string, metadata: { timestamp: number }) => void | No op |

onEvent

This callback allows handling more specific events.

The property event inside the payload param of the onEvent callback, is the name of the current event triggered. The available events that can be handled through this method are:

| Event name | Description | | ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | 'SUBMITTED_CONSENT' | User has confirmed terms & privacy consent on the first Welcome screen. | | 'SELECTED_INSTITUTION' | User has selected an institution to connect to, or has deselected it (ie. navigated back to previous step). | | 'SUBMITTED_LOGIN' | User has submitted credentials to create the connection Item. | | 'SUBMITTED_MFA' | User has submitted an extra parameter that has been requested by the institution to connect. | | 'LOGIN_SUCCESS' | User has submitted credentials to create the connection Item successfully. | | 'LOGIN_MFA_SUCCESS' | User has submitted an extra parameter that has been requested by the institution to connect successfully. | | 'LOGIN_STEP_COMPLETED' | Successful completion of the login. User effectively logged in to the institution. | | 'ITEM_RESPONSE' | Called every time the Item object is retrieved from Pluggy API, either when just created, updated, or each time it's retrieved to poll it's connection/execution status. |

payload object has a property timestamp and some events extra data:

'SELECTED_INSTITUTION' has the connector property which is the connector selected by the user. 'LOGIN_SUCCESS' | 'LOGIN_MFA_SUCCESS' | 'LOGIN_STEP_COMPLETED' | 'ITEM_RESPONSE' events have the item property which is the item data related to the current connection.

Full event parameter type definition is:

type ConnectEventPayload = {
  timestamp: number;
} & (
  | {
      event: 'SUBMITTED_CONSENT' | 'SUBMITTED_LOGIN' | 'SUBMITTED_MFA';
    }
  | {
      event: 'SELECTED_INSTITUTION';
      connector: Connector | null;
    }
  | {
      event: 'LOGIN_SUCCESS' | 'LOGIN_MFA_SUCCESS' | 'LOGIN_STEP_COMPLETED' | 'ITEM_RESPONSE';
      item: Item;
    }
);