Read document catalog from selfClient (#936)

Author: shazarre

app/src/providers/passportDataProvider.tsx

@@ -45,7 +45,6 @@ import type { PropsWithChildren } from 'react';
 import React, { createContext, useCallback, useContext, useMemo } from 'react';
 import Keychain from 'react-native-keychain';
 
-import type { DocumentCategory, PassportData } from '@selfxyz/common/types';
 import type {
   PublicKeyDetailsECDSA,
   PublicKeyDetailsRSA,
@@ -54,14 +53,26 @@ import {
   brutforceSignatureAlgorithmDsc,
   parseCertificateSimple,
 } from '@selfxyz/common/utils';
+import type {
+  DocumentCatalog,
+  DocumentCategory,
+  DocumentMetadata,
+  PassportData,
+} from '@selfxyz/common/utils/types';
+import {
+  DocumentsAdapter,
+  getAllDocuments,
+  SelfClient,
+  useSelfClient,
+} from '@selfxyz/mobile-sdk-alpha';
 
 import { unsafe_getPrivateKey, useAuth } from '@/providers/authProvider';
 
 // Create safe wrapper functions to prevent undefined errors during early initialization
 // These need to be declared early to avoid dependency issues
 const safeLoadDocumentCatalog = async (): Promise<DocumentCatalog> => {
   try {
-    return await loadDocumentCatalog();
+    return await loadDocumentCatalogDirectlyFromKeychain();
   } catch (error) {
     console.warn(
       'Error in safeLoadDocumentCatalog, returning empty catalog:',
@@ -71,9 +82,9 @@ const safeLoadDocumentCatalog = async (): Promise<DocumentCatalog> => {
   }
 };
 
-const safeGetAllDocuments = async () => {
+const safeGetAllDocuments = async (selfClient: SelfClient) => {
   try {
-    return await getAllDocuments();
+    return await getAllDocuments(selfClient);
   } catch (error) {
     console.warn(
       'Error in safeGetAllDocuments, returning empty object:',
@@ -83,20 +94,6 @@ const safeGetAllDocuments = async () => {
   }
 };
 
-export interface DocumentMetadata {
-  id: string; // contentHash as ID for deduplication
-  documentType: string; // passport, mock_passport, id_card, etc.
-  documentCategory: DocumentCategory; // passport, id_card, aadhaar
-  data: string; // DG1/MRZ data for passports/IDs, relevant data for aadhaar
-  mock: boolean; // whether this is a mock document
-  isRegistered?: boolean; // whether the document is registered onChain
-}
-
-export interface DocumentCatalog {
-  documents: DocumentMetadata[];
-  selectedDocumentId?: string; // This is now a contentHash
-}
-
 type DocumentChangeCallback = (isMock: boolean) => void;
 
 const documentChangeCallbacks: DocumentChangeCallback[] = [];
@@ -163,7 +160,7 @@ export const PassportContext = createContext<IPassportContext>({
   clearPassportData: clearPassportData,
   clearSpecificData: clearSpecificPassportData,
   loadDocumentCatalog: safeLoadDocumentCatalog,
-  getAllDocuments: safeGetAllDocuments,
+  getAllDocuments: () => Promise.resolve({}),
   setSelectedDocument: setSelectedDocument,
   deleteDocument: deleteDocument,
   migrateFromLegacyStorage: migrateFromLegacyStorage,
@@ -173,12 +170,12 @@ export const PassportContext = createContext<IPassportContext>({
   markCurrentDocumentAsRegistered: markCurrentDocumentAsRegistered,
   updateDocumentRegistrationState: updateDocumentRegistrationState,
   checkIfAnyDocumentsNeedMigration: checkIfAnyDocumentsNeedMigration,
-  hasAnyValidRegisteredDocument: hasAnyValidRegisteredDocument,
   checkAndUpdateRegistrationStates: checkAndUpdateRegistrationStates,
 });
 
 export const PassportProvider = ({ children }: PassportProviderProps) => {
   const { _getSecurely } = useAuth();
+  const selfClient = useSelfClient();
 
   const getData = useCallback(
     () => _getSecurely<PassportData>(loadPassportData, str => JSON.parse(str)),
@@ -192,7 +189,10 @@ export const PassportProvider = ({ children }: PassportProviderProps) => {
     );
   }, [_getSecurely]);
 
-  const getAllData = useCallback(() => loadAllPassportData(), []);
+  const getAllData = useCallback(
+    () => loadAllPassportData(selfClient),
+    [selfClient],
+  );
 
   const getAvailableTypes = useCallback(() => getAvailableDocumentTypes(), []);
 
@@ -224,7 +224,7 @@ export const PassportProvider = ({ children }: PassportProviderProps) => {
       clearPassportData: clearPassportData,
       clearSpecificData: clearSpecificPassportData,
       loadDocumentCatalog: safeLoadDocumentCatalog,
-      getAllDocuments: safeGetAllDocuments,
+      getAllDocuments: () => safeGetAllDocuments(selfClient),
       setSelectedDocument: setSelectedDocument,
       deleteDocument: deleteDocument,
       migrateFromLegacyStorage: migrateFromLegacyStorage,
@@ -234,7 +234,6 @@ export const PassportProvider = ({ children }: PassportProviderProps) => {
       markCurrentDocumentAsRegistered: markCurrentDocumentAsRegistered,
       updateDocumentRegistrationState: updateDocumentRegistrationState,
       checkIfAnyDocumentsNeedMigration: checkIfAnyDocumentsNeedMigration,
-      hasAnyValidRegisteredDocument: hasAnyValidRegisteredDocument,
       checkAndUpdateRegistrationStates: checkAndUpdateRegistrationStates,
     }),
     [
@@ -263,7 +262,7 @@ export async function checkAndUpdateRegistrationStates(): Promise<void> {
 
 export async function checkIfAnyDocumentsNeedMigration(): Promise<boolean> {
   try {
-    const catalog = await loadDocumentCatalog();
+    const catalog = await loadDocumentCatalogDirectlyFromKeychain();
     return catalog.documents.some(doc => doc.isRegistered === undefined);
   } catch (error) {
     console.warn('Error checking if documents need migration:', error);
@@ -273,7 +272,7 @@ export async function checkIfAnyDocumentsNeedMigration(): Promise<boolean> {
 
 export async function clearDocumentCatalogForMigrationTesting() {
   console.log('Clearing document catalog for migration testing...');
-  const catalog = await loadDocumentCatalog();
+  const catalog = await loadDocumentCatalogDirectlyFromKeychain();
 
   // Delete all new-style documents
   for (const doc of catalog.documents) {
@@ -301,7 +300,7 @@ export async function clearDocumentCatalogForMigrationTesting() {
 }
 
 export async function clearPassportData() {
-  const catalog = await loadDocumentCatalog();
+  const catalog = await loadDocumentCatalogDirectlyFromKeychain();
 
   // Delete all documents
   for (const doc of catalog.documents) {
@@ -317,7 +316,7 @@ export async function clearPassportData() {
 }
 
 export async function clearSpecificPassportData(documentType: string) {
-  const catalog = await loadDocumentCatalog();
+  const catalog = await loadDocumentCatalogDirectlyFromKeychain();
   const docsToDelete = catalog.documents.filter(
     d => d.documentType === documentType,
   );
@@ -328,7 +327,7 @@ export async function clearSpecificPassportData(documentType: string) {
 }
 
 export async function deleteDocument(documentId: string): Promise<void> {
-  const catalog = await loadDocumentCatalog();
+  const catalog = await loadDocumentCatalogDirectlyFromKeychain();
 
   // Remove from catalog
   catalog.documents = catalog.documents.filter(d => d.id !== documentId);
@@ -352,32 +351,14 @@ export async function deleteDocument(documentId: string): Promise<void> {
   }
 }
 
-export async function getAllDocuments(): Promise<{
-  [documentId: string]: { data: PassportData; metadata: DocumentMetadata };
-}> {
-  const catalog = await loadDocumentCatalog();
-  const allDocs: {
-    [documentId: string]: { data: PassportData; metadata: DocumentMetadata };
-  } = {};
-
-  for (const metadata of catalog.documents) {
-    const data = await loadDocumentById(metadata.id);
-    if (data) {
-      allDocs[metadata.id] = { data, metadata };
-    }
-  }
-
-  return allDocs;
-}
-
 export async function getAvailableDocumentTypes(): Promise<string[]> {
-  const catalog = await loadDocumentCatalog();
+  const catalog = await loadDocumentCatalogDirectlyFromKeychain();
   return [...new Set(catalog.documents.map(d => d.documentType))];
 }
 
 // Helper function to get current document type from catalog
 export async function getCurrentDocumentType(): Promise<string | null> {
-  const catalog = await loadDocumentCatalog();
+  const catalog = await loadDocumentCatalogDirectlyFromKeychain();
   if (!catalog.selectedDocumentId) return null;
 
   const metadata = catalog.documents.find(
@@ -404,16 +385,6 @@ function getServiceNameForDocumentType(documentType: string): string {
   }
 }
 
-export async function hasAnyValidRegisteredDocument(): Promise<boolean> {
-  try {
-    const catalog = await loadDocumentCatalog();
-    return catalog.documents.some(doc => doc.isRegistered === true);
-  } catch (error) {
-    console.error('Error loading document catalog:', error);
-    return false;
-  }
-}
-
 /**
  * Global initialization function to wait for native modules to be ready
  * Call this once at app startup before any native module operations
@@ -460,10 +431,11 @@ export async function initializeNativeModules(
   return false;
 }
 
-export async function loadAllPassportData(): Promise<{
+// TODO: is this used?
+async function loadAllPassportData(selfClient: SelfClient): Promise<{
   [service: string]: PassportData;
 }> {
-  const allDocs = await getAllDocuments();
+  const allDocs = await getAllDocuments(selfClient);
   const result: { [service: string]: PassportData } = {};
 
   // Convert to legacy format for backward compatibility
@@ -475,7 +447,7 @@ export async function loadAllPassportData(): Promise<{
   return result;
 }
 
-export async function loadDocumentById(
+export async function loadDocumentByIdDirectlyFromKeychain(
   documentId: string,
 ): Promise<PassportData | null> {
   try {
@@ -499,7 +471,12 @@ export async function loadDocumentById(
   return null;
 }
 
-export async function loadDocumentCatalog(): Promise<DocumentCatalog> {
+export const selfClientDocumentsAdapter: DocumentsAdapter = {
+  loadDocumentCatalog: loadDocumentCatalogDirectlyFromKeychain,
+  loadDocumentById: loadDocumentByIdDirectlyFromKeychain,
+};
+
+export async function loadDocumentCatalogDirectlyFromKeychain(): Promise<DocumentCatalog> {
   try {
     // Extra safety check for module initialization
     if (typeof Keychain === 'undefined' || !Keychain) {
@@ -524,6 +501,9 @@ export async function loadDocumentCatalog(): Promise<DocumentCatalog> {
       if (parsed === null) {
         throw new TypeError('Cannot parse null password');
       }
+
+      console.log('Successfully loaded document catalog from keychain');
+
       return parsed;
     }
   } catch (error) {
@@ -592,7 +572,7 @@ export async function loadSelectedDocument(): Promise<{
   data: PassportData;
   metadata: DocumentMetadata;
 } | null> {
-  const catalog = await loadDocumentCatalog();
+  const catalog = await loadDocumentCatalogDirectlyFromKeychain();
   console.log('Catalog loaded');
 
   if (!catalog.selectedDocumentId) {
@@ -618,7 +598,9 @@ export async function loadSelectedDocument(): Promise<{
     return null;
   }
 
-  const data = await loadDocumentById(catalog.selectedDocumentId);
+  const data = await loadDocumentByIdDirectlyFromKeychain(
+    catalog.selectedDocumentId,
+  );
   if (!data) {
     console.log('Document data not found for id:', catalog.selectedDocumentId);
     return null;
@@ -660,6 +642,7 @@ interface IPassportContext {
     signature: string;
     data: PassportData;
   } | null>;
+  // TODO: is this even used?
   getAllData: () => Promise<{ [service: string]: PassportData }>;
   getAvailableTypes: () => Promise<string[]>;
   setData: (data: PassportData) => Promise<void>;
@@ -673,12 +656,15 @@ interface IPassportContext {
   } | null>;
   clearPassportData: () => Promise<void>;
   clearSpecificData: (documentType: string) => Promise<void>;
+
   loadDocumentCatalog: () => Promise<DocumentCatalog>;
   getAllDocuments: () => Promise<{
     [documentId: string]: { data: PassportData; metadata: DocumentMetadata };
   }>;
+
   setSelectedDocument: (documentId: string) => Promise<void>;
   deleteDocument: (documentId: string) => Promise<void>;
+
   migrateFromLegacyStorage: () => Promise<void>;
   getCurrentDocumentType: () => Promise<string | null>;
   clearDocumentCatalogForMigrationTesting: () => Promise<void>;
@@ -688,12 +674,11 @@ interface IPassportContext {
     isRegistered: boolean,
   ) => Promise<void>;
   checkIfAnyDocumentsNeedMigration: () => Promise<boolean>;
-  hasAnyValidRegisteredDocument: () => Promise<boolean>;
   checkAndUpdateRegistrationStates: () => Promise<void>;
 }
 
 export async function markCurrentDocumentAsRegistered(): Promise<void> {
-  const catalog = await loadDocumentCatalog();
+  const catalog = await loadDocumentCatalogDirectlyFromKeychain();
   if (catalog.selectedDocumentId) {
     await updateDocumentRegistrationState(catalog.selectedDocumentId, true);
   } else {
@@ -703,7 +688,7 @@ export async function markCurrentDocumentAsRegistered(): Promise<void> {
 
 export async function migrateFromLegacyStorage(): Promise<void> {
   console.log('Migrating from legacy storage to new architecture...');
-  const catalog = await loadDocumentCatalog();
+  const catalog = await loadDocumentCatalogDirectlyFromKeychain();
 
   // If catalog already has documents, skip migration
   if (catalog.documents.length > 0) {
@@ -789,15 +774,15 @@ export async function saveDocumentCatalog(
 }
 
 export async function setDefaultDocumentTypeIfNeeded() {
-  const catalog = await loadDocumentCatalog();
+  const catalog = await loadDocumentCatalogDirectlyFromKeychain();
 
   if (!catalog.selectedDocumentId && catalog.documents.length > 0) {
     await setSelectedDocument(catalog.documents[0].id);
   }
 }
 
 export async function setSelectedDocument(documentId: string): Promise<void> {
-  const catalog = await loadDocumentCatalog();
+  const catalog = await loadDocumentCatalogDirectlyFromKeychain();
   const metadata = catalog.documents.find(d => d.id === documentId);
 
   if (metadata) {
@@ -812,7 +797,7 @@ export async function storeDocumentWithDeduplication(
   passportData: PassportData,
 ): Promise<string> {
   const contentHash = calculateContentHash(passportData);
-  const catalog = await loadDocumentCatalog();
+  const catalog = await loadDocumentCatalogDirectlyFromKeychain();
 
   // Check for existing document with same content
   const existing = catalog.documents.find(d => d.id === contentHash);
@@ -868,7 +853,7 @@ export async function updateDocumentRegistrationState(
   documentId: string,
   isRegistered: boolean,
 ): Promise<void> {
-  const catalog = await loadDocumentCatalog();
+  const catalog = await loadDocumentCatalogDirectlyFromKeychain();
   const documentIndex = catalog.documents.findIndex(d => d.id === documentId);
 
   if (documentIndex !== -1) {
@@ -885,3 +870,29 @@ export async function updateDocumentRegistrationState(
 export const usePassport = () => {
   return useContext(PassportContext);
 };
+
+/**
+ * Get all documents directly from the keychain.
+ *
+ * It's here to avoid dependency on self client where it's not strictly necessary,
+ * for example when migrating legacy data.
+ *
+ * @returns A dictionary of document IDs to their data and metadata.
+ */
+export const getAllDocumentsDirectlyFromKeychain = async (): Promise<{
+  [documentId: string]: { data: PassportData; metadata: DocumentMetadata };
+}> => {
+  const catalog = await loadDocumentCatalogDirectlyFromKeychain();
+  const allDocs: {
+    [documentId: string]: { data: PassportData; metadata: DocumentMetadata };
+  } = {};
+
+  for (const metadata of catalog.documents) {
+    const data = await loadDocumentByIdDirectlyFromKeychain(metadata.id);
+    if (data) {
+      allDocs[metadata.id] = { data, metadata };
+    }
+  }
+
+  return allDocs;
+};