Equal PFM SDK

A JavaScript SDK for integrating with Equal's Personal Finance Management platform.

Installation

npm install equal-nextjs-pfm-sdk

Usage

Browser

<script src="node_modules/equal-nextjs-pfm-sdk/src/pfm_sdk.js"></script>
<script>
  const sdk = new PFMSDK('your-token', 'uat');

  sdk.openPFM(
    (error) => console.error('Error:', error),
    (closeData) => console.log('Closed:', closeData)
  );
</script>

Node.js / TypeScript

import PFMSDK from 'equal-nextjs-pfm-sdk';
// or with CommonJS: const PFMSDK = require('equal-nextjs-pfm-sdk');

const sdk = new PFMSDK('your-token', 'uat');

sdk.openPFM(
  (error) => console.error('Error:', error),
  (closeData) => console.log('Closed:', closeData)
);

TypeScript Example

import PFMSDK, { SDKCallback } from 'equal-nextjs-pfm-sdk';

const onError: SDKCallback = (data) => {
  console.error(`Error: ${data.message} (${data.statusCode})`);
};

const onClose: SDKCallback = (data) => {
  console.log(`SDK closed: ${data.message}`);
};

const sdk = new PFMSDK('your-token', 'uat');
sdk.openPFM(onError, onClose);

Next.js Integration Example

// components/PFMComponent.tsx
import { useState, useRef } from 'react';
import PFMSDK, { SDKCallback } from 'equal-nextjs-pfm-sdk';

export default function PFMComponent() {
  private sdk: PFMSDK;

  const [token, setToken] = useState<string | null>(null);

  const initializeSDK = (token: string) => {
    this.sdk = new PFMSDK(token, 'uat');
  }

  const openPFM = () => {
    this.sdk.openPFM(
      (error) => console.error('SDK Error:', error),
      (closeData) => console.log('SDK Closed:', closeData)
    );
  }
}

API Reference

PFMSDK(token, env)

Creates a new instance of the SDK.

• token (string): Authentication token
• env (string): Environment. Use 'uat' for testing and 'production' for live environment

openPFM(onErrorEvent, onCloseEvent)

Opens the PFM interface.

• onErrorEvent (function): Callback for error events
• onCloseEvent (function): Callback for close events

License

ISC