@magicred-1/ble-mesh 1.2.4 → 1.2.5

package/README.md

@@ -108,6 +108,35 @@ interface MeshServiceConfig {
 
 Stops the mesh service and disconnects from all peers.
 
+##### `requestPermissions(): Promise<PermissionStatus>`
+
+Requests all required Bluetooth and location permissions. Called automatically by `start()` unless `autoRequestPermissions: false`.
+
+```typescript
+interface PermissionStatus {
+  bluetooth: boolean;
+  bluetoothAdvertise?: boolean; // Android 12+
+  bluetoothConnect?: boolean;   // Android 12+
+  bluetoothScan?: boolean;      // Android 12+
+  location: boolean;
+}
+
+const permissions = await BleMesh.requestPermissions();
+if (!permissions.bluetooth || !permissions.location) {
+  console.error('Required permissions not granted');
+}
+```
+
+##### `checkPermissions(): Promise<PermissionStatus>`
+
+Checks current permission status without requesting. Useful for showing permission UI state.
+
+```typescript
+const permissions = await BleMesh.checkPermissions();
+console.log('Bluetooth enabled:', permissions.bluetooth);
+console.log('Location enabled:', permissions.location);
+```
+
 ##### `setNickname(nickname: string): Promise<void>`
 
 Updates your nickname and broadcasts the change to peers.
@@ -226,23 +255,76 @@ await BleMesh.respondToTransaction(txId, senderPeerId, {
 
 ##### `hasEncryptedSession(peerId: string): Promise<boolean>`
 
-Checks if an encrypted session exists with the specified peer.
+Checks if an encrypted session exists with the specified peer. Useful for verifying secure communication is established before sending sensitive data.
+
+```typescript
+const hasSession = await BleMesh.hasEncryptedSession(peerId);
+if (hasSession) {
+  console.log('Secure session active');
+} else {
+  console.log('No encrypted session - need handshake');
+}
+```
 
 ##### `initiateHandshake(peerId: string): Promise<void>`
 
-Initiates a Noise handshake with a peer for encrypted communication.
+Initiates a Noise handshake with a peer for encrypted communication. Required before sending private messages or transactions.
+
+```typescript
+// Manually establish encrypted session
+await BleMesh.initiateHandshake(peerId);
+await new Promise(resolve => setTimeout(resolve, 500)); // Wait for completion
+
+// Now send encrypted data
+await BleMesh.sendPrivateMessage('Secret data', peerId);
+```
+
+##### `sendSolanaNonceTransaction(transaction: SolanaNonceTransaction, recipientPeerId: string): Promise<string>`
+
+Sends a durable transaction using Solana nonce accounts for offline transaction signing.
+
+```typescript
+interface SolanaNonceTransaction {
+  recentBlockhash: string;
+  nonceAccount: string;
+  nonceAuthority: string;
+  feePayer: string;
+  instructions: Array<{
+    programId: string;
+    keys: Array<{ pubkey: string; isSigner: boolean; isWritable: boolean }>;
+    data: string; // base64 encoded
+  }>;
+}
+
+const txId = await BleMesh.sendSolanaNonceTransaction({
+  recentBlockhash: nonceAccountValue,
+  nonceAccount: nonceAccountPubkey,
+  nonceAuthority: authorityPubkey,
+  feePayer: feePayerPubkey,
+  instructions: [/* ... */]
+}, recipientPeerId);
+```
 
 ##### `getIdentityFingerprint(): Promise<string>`
 
-Returns your identity fingerprint for verification.
+Returns your identity fingerprint for verification. Share this with peers to verify your identity.
 
 ##### `getPeerFingerprint(peerId: string): Promise<string | null>`
 
-Returns a peer's identity fingerprint for verification.
+Returns a peer's identity fingerprint for verification. Compare with their shared fingerprint to verify identity.
+
+```typescript
+const peerFingerprint = await BleMesh.getPeerFingerprint(peerId);
+if (peerFingerprint === sharedFingerprint) {
+  console.log('Identity verified!');
+} else {
+  console.warn('Identity mismatch - possible MITM attack');
+}
+```
 
 ##### `broadcastAnnounce(): Promise<void>`
 
-Forces a broadcast announce to refresh your presence on the mesh.
+Forces a broadcast announce to refresh your presence on the mesh. Useful for re-announcing after network connectivity changes.
 
 #### Events
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@magicred-1/ble-mesh",
-  "version": "1.2.4",
+  "version": "1.2.5",
   "description": "BLE Mesh networking library for React Native with seamless permissions",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",