equal-angular-pfm-sdk/README.md

Equal PFM Angular SDK

# Equal PFM SDK

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

## Installation

```bash
npm install equal-pfm-sdk-test
```

## Usage

### Browser

```html
<script src="node_modules/equal-pfm-sdk-test/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

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

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

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

### TypeScript Example

```typescript
import PFMSDK, { SDKCallback } from 'equal-pfm-sdk-test';

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);
```

## Angular Integration Example

```typescript
// app.component.ts
import { Component, OnInit } from '@angular/core';
import PFMSDK, { SDKCallback } from 'equal-pfm-sdk-test';

@Component({
  selector: 'app-root',
  templateUrl: './app.component.html',
})
export class AppComponent implements OnInit {
  private sdk: PFMSDK;

  constructor() {
    this.sdk = new PFMSDK('your-token', 'uat');
  }

  ngOnInit() {
    // Initialize SDK
  }

  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