chore: add documentation for react native sdk

Author: jackpooleyml

packages/sdk-platforms/react-native/react-native-zksync-sso/src/passkey/authenticate.ts

@@ -10,6 +10,13 @@ import {
     arrayBufferToBase64Url
 } from './utils';
 
+/**
+ * Authenticates a user using their platform passkey and returns the authentication data.
+ * 
+ * @param message - The challenge message to authenticate against, as an ArrayBuffer
+ * @param rpId - The relying party ID used for passkey authentication
+ * @returns A Promise that resolves to an ArrayBuffer containing the encoded authentication payload
+ */
 export const authenticateWithPasskey = async (
     message: ArrayBuffer,
     rpId: string

packages/sdk-platforms/react-native/react-native-zksync-sso/src/passkey/authenticate/authenticator.ts

@@ -2,13 +2,26 @@
 import { type PasskeyAuthenticatorAsync } from 'react-native-zksync-sso';
 import { authenticateWithPasskey } from '../authenticate';
 
+/**
+ * Authenticator class that implements passkey-based authentication.
+ * This class handles the signing of messages using platform-specific passkey authentication.
+ */
 export class Authenticator implements PasskeyAuthenticatorAsync {
     private rpId: string;
 
+    /**
+     * Creates a new Authenticator instance.
+     * @param rpId - The relying party ID used for passkey authentication
+     */
     constructor(rpId: string) {
         this.rpId = rpId;
     }
 
+    /**
+     * Signs a message using the platform's passkey authentication.
+     * @param message - The message to sign as an ArrayBuffer
+     * @returns A Promise that resolves to the signed message as an ArrayBuffer
+     */
     async signMessage(
         message: ArrayBuffer,
     ): Promise<ArrayBuffer> {

packages/sdk-platforms/react-native/react-native-zksync-sso/src/passkey/register.ts

@@ -15,17 +15,34 @@ import {
     base64ToArrayBuffer
 } from './utils';
 
+/**
+ * Information about the relying party (RP) for passkey registration
+ */
 export interface RPInfo {
     name: string;
     id: string;
 }
 
+/**
+ * Information about the account being registered
+ */
 export interface AccountInfo {
     name: string;
     userID: string;
     rp: RPInfo;
 }
 
+/**
+ * Registers a new account using a platform passkey and deploys it.
+ * This function handles the creation of a new passkey and the deployment of the account
+ * with the generated credentials.
+ * 
+ * @param accountInfo - Information about the account to register
+ * @param secretAccountSalt - Salt used for account derivation
+ * @param challenge - Challenge string for passkey creation
+ * @param config - Configuration for deployment
+ * @returns A Promise that resolves to the deployed Account
+ */
 export const registerAccountWithUniqueId = async (
     accountInfo: AccountInfo,
     secretAccountSalt: string,