pi-spi-sdk 0.1.1 → 0.1.2

package/README.md

@@ -4,8 +4,7 @@
 
 The Interoperable Platform for the Instant Payment System (π-SPI) is a regional payment infrastructure designed and operated by the Central Bank of West African States (BCEAO).
 
-It enables instant fund transfers between different financial institutions across the region, including banks, electronic money issuers, microfinance institutions, and payment establishments.
-
+It enables instant fund transfers between different financial institutions across the region, including banks, electronic money issuers, microfinance institutions, and payment service providers.
 
 ## Installation
 
@@ -16,13 +15,12 @@ npm install pi-spi-sdk
 # or
 yarn add pi-spi-sdk
 ```
-π-SPI enables **cross-border transactions** within the West African Economic and Monetary Union (UEMOA), which spans eight countries: Benin, Burkina Faso, Côte d'Ivoire, Guinea-Bissau, Mali, Niger, Senegal, and Togo. 
 
-The infrastructure operates on a single currency, the XOF (West African CFA Franc), and processes payments in real-time with instant confirmation. Users can send payments using alias-based methods, which means they don't need to share their actual account numbers.
+π-SPI operates on a single currency, the XOF (West African CFA Franc), and processes payments in real-time with instant confirmation. It also enables **cross-border transactions** within the West African Economic and Monetary Union (UEMOA), which spans eight countries: Benin, Burkina Faso, Côte d'Ivoire, Guinea-Bissau, Mali, Niger, Senegal, and Togo. 
 
-**Transaction types supported:**
+Payments can flow between traditional bank accounts across UEMOA countries, from bank accounts to mobile money wallets like MTN, Orange Money, and Moov, from mobile wallets back to bank accounts, and even between mobile money wallets regardless of which provider each person uses.
 
-π-SPI supports seamless interoperability between different payment systems throughout the region. Payments can flow between traditional bank accounts across UEMOA countries, from bank accounts to mobile money wallets like MTN, Orange Money, and Moov, from mobile wallets back to bank accounts, and even between mobile money wallets regardless of which provider each person uses. All these transaction types work seamlessly through the unified infrastructure, enabling businesses and individuals to send and receive payments across different financial institutions and mobile money providers within the UEMOA region.
+To use this SDK in a production ready application, you need to be connected to a certified PI-SPI participant or PSP.
 
 ## Usage example
 
@@ -30,7 +28,7 @@ The infrastructure operates on a single currency, the XOF (West African CFA Fran
 import { PiSpiSDK } from 'pi-spi-sdk';
 
 const sdk = new PiSpiSDK({
-  baseUrl: 'https://sandbox.api.pi-bceao.com/piz/v1',
+  baseUrl: 'https://sandbox.api.pi-spi.bceao.int/piz/v1',
   accessToken: 'your-oauth2-access-token',
 });
 
@@ -48,7 +46,7 @@ const payment = await sdk.paiements.create({
 
 ## Features
 
-This SDK provides full TypeScript support with types generated from the official OpenAPI specification, ensuring type safety throughout your integration. It includes secure authentication through OAuth2 and mTLS, comprehensive coverage of all SPI endpoints, and custom error classes with detailed messages for easier debugging. The codebase is auto-generated from the official specification and includes developer-friendly utilities and constants to streamline your implementation.
+This SDK provides full TypeScript support with types generated from the official OpenAPI specification, ensuring type safety throughout your integration. It includes secure authentication through OAuth2 and mTLS, comprehensive coverage of all SPI endpoints, and custom error classes with detailed messages for easier debugging. The codebase also includes developer-friendly utilities and constants to streamline your implementation.
 
 ## Utilities & Constants
 
@@ -162,6 +160,36 @@ await sdk.paiements.list({
 });
 ```
 
+#### QR Codes
+
+Generate EMV-compliant QR codes directly from the SDK.
+
+```typescript
+// Generate raw payload string
+const payload = sdk.qr.payload({
+  alias: '3497a720-ab11-4973-9619-534e04f263a1',
+  countryCode: 'CI',
+  qrType: 'STATIC',
+  referenceLabel: 'MA_BOUTIQUE_01',
+});
+
+// Generate SVG with official PI-SPI logo
+const svg = await sdk.qr.svg({
+  alias: '3497a720-ab11-4973-9619-534e04f263a1',
+  countryCode: 'CI',
+  qrType: 'DYNAMIC',
+  referenceLabel: 'TX-12345',
+  amount: 5000
+}, { size: 300 });
+
+// Validate external QR code content
+const check = sdk.qr.validate(someQrString);
+if (check.valid) {
+  console.log("Valid QR for:", check.data?.alias);
+}
+```
+
+
 #### Aliases
 
 ```typescript

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pi-spi-sdk",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "TypeScript SDK for the π-SPI Business API. Built by lomi. for the West African fintech community",
   "type": "module",
   "main": "dist/index.js",
@@ -18,6 +18,13 @@
     "LICENSE",
     "CHANGELOG.md"
   ],
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch",
+    "format": "prettier --write \"src/**/*.{ts,tsx,json,md}\" \"*.{json,md}\" \"scripts/**/*.{js,ts}\"",
+    "prepublish": "pnpm run generate && pnpm run build",
+    "generate": "node scripts/pre-generate.js && openapi --input ./openapi.json --output ./src/generated --client axios --useOptions && node scripts/post-generate.js"
+  },
   "keywords": [
     "pi-spi",
     "spi",
@@ -60,22 +67,18 @@
     "node": ">=18.0.0"
   },
   "dependencies": {
-    "axios": "^1.8.4",
-    "dotenv": "^16.4.5",
-    "form-data": "^4.0.2"
+    "axios": "^1.13.2",
+    "dotenv": "^16.6.1",
+    "form-data": "^4.0.5",
+    "qrcode": "^1.5.4"
   },
   "devDependencies": {
     "@types/form-data": "^2.5.2",
-    "@types/node": "^20.10.6",
+    "@types/node": "^20.19.25",
+    "@types/qrcode": "^1.5.6",
     "openapi-typescript-codegen": "^0.29.0",
-    "prettier": "^3.2.5",
-    "typescript": "^5.3.3"
-  },
-  "scripts": {
-    "build": "tsc",
-    "dev": "tsc --watch",
-    "format": "prettier --write \"src/**/*.{ts,tsx,json,md}\" \"*.{json,md}\" \"scripts/**/*.{js,ts}\"",
-    "prepublish": "pnpm run generate && pnpm run build",
-    "generate": "node scripts/pre-generate.js && openapi --input ./openapi.json --output ./src/generated --client axios --useOptions && node scripts/post-generate.js"
+    "prettier": "^3.6.2",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.16"
   }
-}
+}