@uin-federation/sdk/README.md

This SDK connects to the NUI Federation API for getting or creating, revoke, generating batch for NUI from the API

# UIN Federation SDK

![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/digital-gov-mg/uin-federation/ci.yml?style=flat-square)
![NPM License](https://img.shields.io/npm/l/%40uin-federation%2Fsdk?style=flat-square)
![NPM Version](https://img.shields.io/npm/v/%40uin-federation%2Fsdk?style=flat-square)
![npm bundle size](https://img.shields.io/bundlephobia/min/%40uin-federation%2Fsdk?style=flat-square)

This SDK connects to the UIN Federation API for getting or creating, revoke, generating batch for UIN from the API.

## Installation

### Package Manager

```sh
npm install @uin-federation/sdk
```

# Example

```ts
import UINFederation from '@uin-federation/sdk'

// Initialize UINFederation
const baseUrl = 'https://example.com/api'
const clientId = 'your-client-id'
const clientSecret = 'your-client'

const federation = new UINFederation({
  baseUrl: 'https://api.example.com',
  clientId: 'client123',
  clientSecret: 'secret456',
})

// Example 1: Get or Create UIN
const citizenDatas = [
  {
    externalId: '123',
    firstname: 'John',
    lastname: 'Doe',
    dateOfBirth: '2000-01-01',
    birthCertificateId: 'BC123',
    motherName: 'Jane Doe',
  },
]

try {
  const res = await federation.uins.getOrCreate(citizenDatas)
  console.log('UIN Response:', res)
} catch (err) {
  console.log('Error creating or fetching UIN:', err.message)
}

// Example 2: Revoke a UIN
const uin = '1234567890'
try {
  const res = await federation.uins.revoke(uin)
  console.log('Revoke UIN Response:', res)
} catch (err) {
  console.log('Error revoking UIN:', err.message)
}

// Example 3: Generate UIN Batch
const count = 5
try {
  const res = await federation.uins.generateBatch(count)
  console.log('Generate UIN Batch Response:', res)
} catch (err) {
  console.log('Error generating UIN Batch:', err.message)
}
```