feat: implement database synchronization system with multi-branch support and conflict detection

Author: PraneethKulukuri26

package.json

@@ -1,6 +1,6 @@
 {
   "name": "api-documenter",
-  "version": "1.0.22",
+  "version": "1.0.23",
   "description": "Self-hosted Postman alternative with folder-level RBAC and offline-first documentation",
   "main": "./out/main/index.js",
   "author": "Praneeth Kulukuri",

server/routes/apis/index.ts

@@ -32,18 +32,18 @@ export default async function handler(req: any, res: any) {
             let apis: any[] = [];
             if (folderId) {
                 await checkFolderAccess(context, folderId, 'read');
-                apis = await db.query('SELECT * FROM api_collections WHERE folder_id = ? AND branch = ?', [folderId, activeBranch]);
+                apis = await db.query('SELECT * FROM api_collections WHERE folder_id = ? AND branch = ? AND (is_deleted = 0 OR is_deleted = false OR is_deleted IS NULL)', [folderId, activeBranch]);
             } else {
                 // Return all APIs user has access to
                 const isWildcard = Array.isArray(user.allowedFolders)
                     ? user.allowedFolders.includes('*')
                     : !!(user.allowedFolders as Record<string, any>)['*'];
 
                 if (user.role === 'admin' || isWildcard) {
-                    apis = await db.query('SELECT * FROM api_collections WHERE project_id = ? AND branch = ?', [user.projectId, activeBranch]);
+                    apis = await db.query('SELECT * FROM api_collections WHERE project_id = ? AND branch = ? AND (is_deleted = 0 OR is_deleted = false OR is_deleted IS NULL)', [user.projectId, activeBranch]);
                 } else {
                     // Resolve actual folder IDs by checking both ID and name in permissions
-                    const allFolders = await db.query('SELECT id, name FROM folders WHERE project_id = ? AND branch = ?', [user.projectId, activeBranch]);
+                    const allFolders = await db.query('SELECT id, name FROM folders WHERE project_id = ? AND branch = ? AND (is_deleted = 0 OR is_deleted = false OR is_deleted IS NULL)', [user.projectId, activeBranch]);
                     const allowedFolderIds = allFolders.filter((f: any) => {
                         return (user.allowedFolders as any[]).some((p: any) => {
                             const idOrName = typeof p === 'string' ? p : p.folderId;
@@ -56,7 +56,7 @@ export default async function handler(req: any, res: any) {
                     } else {
                         const placeholders = allowedFolderIds.map(() => '?').join(',');
                         apis = await db.query(
-                            `SELECT * FROM api_collections WHERE project_id = ? AND branch = ? AND folder_id IN (${placeholders})`,
+                            `SELECT * FROM api_collections WHERE project_id = ? AND branch = ? AND folder_id IN (${placeholders}) AND (is_deleted = 0 OR is_deleted = false OR is_deleted IS NULL)`,
                             [user.projectId, activeBranch, ...allowedFolderIds]
                         );
                     }

server/routes/sync.ts

@@ -68,9 +68,11 @@ export default async function handler(req: any, res: any) {
                     console.log(`[Sync] Processing folder: ${payload.name} (${operation})`);
 
                     // Conflict detection
-                    const existing = await db.query<any>('SELECT version FROM folders WHERE id = ? AND branch = ?', [payload.id, branchName]);
-                    if (existing.length > 0 && baseVersion > 0 && (existing[0].version || 1) > baseVersion) {
-                        results.push({ id: entry.id, status: 'conflict', dbVersion: existing[0].version, localVersion: payload.version, baseVersion });
+                    const existing = await db.query<any>('SELECT version, is_deleted FROM folders WHERE id = ? AND branch = ?', [payload.id, branchName]);
+                    if (existing.length > 0 && existing[0].is_deleted && operation === 'delete') {
+                        // Already deleted remotely, no conflict
+                    } else if (existing.length > 0 && baseVersion > 0 && (existing[0].version || 1) > baseVersion) {
+                        results.push({ id: entry.id, status: 'conflict', dbVersion: existing[0].version, localVersion: payload.version, baseVersion, isDeleted: existing[0].is_deleted ? true : false });
                         continue;
                     }
 
@@ -96,9 +98,11 @@ export default async function handler(req: any, res: any) {
                     console.log(`[Sync] Processing API: ${payload.name} in folder ${folderId} (${operation})`);
 
                     // Conflict detection
-                    const existing = await db.query<any>('SELECT version FROM api_collections WHERE id = ? AND branch = ?', [payload.id, branchName]);
-                    if (existing.length > 0 && baseVersion > 0 && (existing[0].version || 1) > baseVersion) {
-                        results.push({ id: entry.id, status: 'conflict', dbVersion: existing[0].version, localVersion: payload.version, baseVersion });
+                    const existing = await db.query<any>('SELECT version, is_deleted FROM api_collections WHERE id = ? AND branch = ?', [payload.id, branchName]);
+                    if (existing.length > 0 && existing[0].is_deleted && operation === 'delete') {
+                        // Already deleted remotely, no conflict
+                    } else if (existing.length > 0 && baseVersion > 0 && (existing[0].version || 1) > baseVersion) {
+                        results.push({ id: entry.id, status: 'conflict', dbVersion: existing[0].version, localVersion: payload.version, baseVersion, isDeleted: existing[0].is_deleted ? true : false });
                         continue;
                     }
 
@@ -145,9 +149,11 @@ export default async function handler(req: any, res: any) {
                     console.log(`[Sync] Processing environment: ${payload.name} (${operation})`);
 
                     // Conflict detection
-                    const existing = await db.query<any>('SELECT version FROM environments WHERE id = ? AND branch = ?', [payload.id, branchName]);
-                    if (existing.length > 0 && baseVersion > 0 && (existing[0].version || 1) > baseVersion) {
-                        results.push({ id: entry.id, status: 'conflict', dbVersion: existing[0].version, localVersion: payload.version, baseVersion });
+                    const existing = await db.query<any>('SELECT version, is_deleted FROM environments WHERE id = ? AND branch = ?', [payload.id, branchName]);
+                    if (existing.length > 0 && existing[0].is_deleted && operation === 'delete') {
+                        // Already deleted remotely, no conflict
+                    } else if (existing.length > 0 && baseVersion > 0 && (existing[0].version || 1) > baseVersion) {
+                        results.push({ id: entry.id, status: 'conflict', dbVersion: existing[0].version, localVersion: payload.version, baseVersion, isDeleted: existing[0].is_deleted ? true : false });
                         continue;
                     }
 

server/src/db/proxyDb.ts

@@ -162,7 +162,7 @@ export async function verifyUserRole(adapter: DbAdapter, user: string | null, to
 
 export async function getAllFolders(adapter: DbAdapter, projectId: string) {
     const rows = await adapter.query<any>(
-        'SELECT id, name, description FROM folders WHERE project_id = ? ORDER BY order_index',
+        'SELECT id, name, description FROM folders WHERE project_id = ? AND (is_deleted IS NULL OR is_deleted = FALSE OR is_deleted = 0) ORDER BY order_index',
         [projectId]
     );
     return rows;
@@ -181,20 +181,23 @@ export async function getApisByFolders(adapter: DbAdapter, projectId: string, al
         SELECT ac.*, f.name as folder_name, f.description as folder_description 
         FROM api_collections ac
         JOIN folders f ON ac.folder_id = f.id
-        WHERE ac.project_id = ? AND f.name IN (${placeholders})
+        WHERE ac.project_id = ? 
+          AND f.name IN (${placeholders})
+          AND (ac.is_deleted IS NULL OR ac.is_deleted = FALSE OR ac.is_deleted = 0)
+          AND (f.is_deleted IS NULL OR f.is_deleted = FALSE OR f.is_deleted = 0)
         ORDER BY f.order_index, ac.created_at
     `, [projectId, ...allowedFolders]);
 
     return rows;
 }
 
 export async function getFolderById(adapter: DbAdapter, folderId: string, projectId: string) {
-    const rows = await adapter.query<any>('SELECT * FROM folders WHERE id = ? AND project_id = ?', [folderId, projectId]);
+    const rows = await adapter.query<any>('SELECT * FROM folders WHERE id = ? AND project_id = ? AND (is_deleted IS NULL OR is_deleted = FALSE OR is_deleted = 0)', [folderId, projectId]);
     return rows[0];
 }
 
 export async function getApisByFolder(adapter: DbAdapter, folderId: string, projectId: string) {
-    const rows = await adapter.query<any>('SELECT * FROM api_collections WHERE folder_id = ? AND project_id = ?', [folderId, projectId]);
+    const rows = await adapter.query<any>('SELECT * FROM api_collections WHERE folder_id = ? AND project_id = ? AND (is_deleted IS NULL OR is_deleted = FALSE OR is_deleted = 0)', [folderId, projectId]);
     return rows;
 }