fix(public): add missing return types to publicService functions

Author: hariom888

apps/backend/src/routes/public.ts

@@ -1,76 +1,21 @@
-import { getErrorMessage } from '../utils/error.util.js';
+import * as publicService from '../services/publicService.js';
 import { generateQRBuffer, generateQRSvg } from '../utils/qr.js';
 
-import type { PlatformLink } from '@devcard/shared';
 import type { FastifyContextConfig, FastifyInstance, FastifyRequest, FastifyReply } from 'fastify';
 
-type PublicProfileLink = {
-  id: string;
-  platform: string;
-  username: string; 
-  url: string; 
-  displayOrder: number; 
-  followed?: boolean;
-}
-
-type UsernamePublicProfileResponse =  {
-  username: string; 
-  displayName: string;
-  bio: string | null; 
-  pronouns: string | null; 
-  role: string | null; 
-  company: string | null;
-  avatarUrl: string | null; 
-  accentColor: string;
-  links: PublicProfileLink[]
-} 
-
-type PublicProfileCardLink = {
-  id: string;
-  platform: string;
-  username: string; 
-  url: string; 
-  followed?: boolean;
-}
-
-type CardPublicProfileResponse = {
-  id: string; 
-  title: string; 
-  owner: {
-    username: string; 
-    displayName: string; 
-    bio: string | null;
-    avatarUrl: string | null;
-    accentColor: string; 
-  }; 
-  links: PublicProfileCardLink[]
-}
-
-type UsernameCardPublicProfileResponse = {
-  title: string; 
-  owner: {
-    username: string; 
-    displayName: string;
-    bio: string | null; 
-    pronouns: string | null; 
-    role: string | null; 
-    company: string | null;
-    avatarUrl: string | null; 
-    accentColor: string;
-  }; 
-  links: PublicProfileCardLink[]
-}
-
-// Represents a CardLink record with the joined PlatformLink relation
-interface CardLinkWithPlatform {
-  id: string;
-  displayOrder: number;
-  platformLink: PlatformLink;
-}
+// ── QR size bounds ────────────────────────────────────────────────────────────
+const MIN_QR_SIZE = 1;
+const MAX_QR_SIZE = 2048;
 
+// ── Cache constants ───────────────────────────────────────────────────────────
+const CACHE_CONTROL_HEADER = 'public, max-age=300, stale-while-revalidate=60';
 
 export async function publicRoutes(app: FastifyInstance): Promise<void> {
-  // ─── Public Profile ───
+  // ─── Public Profile ───────────────────────────────────────────────────────
+  /**
+   * GET /api/u/:username
+   * Returns the public profile information for a user.
+   */
   app.get('/:username', {
     config: {
       rateLimit: {
@@ -81,69 +26,23 @@ export async function publicRoutes(app: FastifyInstance): Promise<void> {
   }, async (request: FastifyRequest<{ Params: { username: string } }>, reply: FastifyReply) => {
     const { username } = request.params;
 
-    // Try to extract viewer from Authorization header (soft auth).
+    // Soft auth: extract viewer id if token present.
+    // authenticatedUserId is used to detect self-views; viewerId is only set
+    // for other authenticated users so the service knows who is viewing.
     let viewerId: string | null = null;
-    let isSelfView = false;
+    let authenticatedUserId: string | null = null;
     try {
       if (request.headers.authorization) {
         const decoded = (await request.jwtVerify()) as { id?: string };
-        if (decoded?.id === user.id) {
-          isSelfView = true;
-        } else {
-          viewerId = decoded?.id ?? null;
-        }
-      } else {
-        viewerId = null;
+        authenticatedUserId = decoded?.id ?? null;
+        viewerId = authenticatedUserId;
       }
     } catch {
-      // Ignored if invalid token
-    }
-
-    // Don't track if the owner is viewing their own profile
-    if (!isSelfView && viewerId !== user.id) {
-      // Background view tracking
-      app.prisma.cardView.create({
-        data: {
-          ownerId: user.id,
-          cardId: null, // this is a profile view, not a card view
-          viewerId,
-          viewerIp: request.ip || null,
-          viewerAgent: request.headers['user-agent'] || null,
-          source: request.query?.source || 'link',
-        },
-      }).catch((err: unknown) => app.log.error(`Failed to log view: ${getErrorMessage(err)}`));
-    }
-
-    // Fetch viewer's successful follow logs for this profile's links
-    let followedLinkIds: string[] = [];
-    if (viewerId && user.platformLinks.length > 0) {
-      const successfulFollows = await app.prisma.followLog.findMany({
-        where: {
-          followerId: viewerId,
-          status: 'success',
-          OR: user.platformLinks.map((link: PlatformLink) => ({
-            platform: link.platform,
-            targetUsername: link.username,
-          })),
-        },
-        select: {
-          platform: true,
-          targetUsername: true,
-        },
-      });
-
-      followedLinkIds = user.platformLinks
-        .filter((link: PlatformLink) =>
-          successfulFollows.some((f: { platform: string; targetUsername: string }) =>
-            f.platform === link.platform &&
-            f.targetUsername.toLowerCase() === link.username.toLowerCase()
-          )
-        )
-        .map((link: PlatformLink) => link.id);
+      // ignored — treat as unauthenticated
     }
 
     try {
-      const result = await publicService.getPublicProfile(app, username, viewerId, request);
+      const result = await publicService.getPublicProfile(app, username, viewerId, request, authenticatedUserId);
       if (!result) {
         return reply.status(404).send({ error: 'User not found' });
       }
@@ -169,44 +68,36 @@ export async function publicRoutes(app: FastifyInstance): Promise<void> {
         timeWindow: '1 minute'
       }
     } as FastifyContextConfig
-  }, async (request: FastifyRequest<{ Params: { cardId: string } }>, _reply: FastifyReply) => {
+  }, async (request: FastifyRequest<{ Params: { cardId: string } }>, reply: FastifyReply) => {
     const { cardId } = request.params;
 
-    const card = await app.prisma.card.findUnique({
-      where: { id: cardId },
-      include: {
-        user: true,
-        cardLinks: {
-          include: { platformLink: true },
-          orderBy: { displayOrder: 'asc' },
+    try {
+      const card = await publicService.getCardById(app, cardId);
+      if (!card) {
+        return reply.status(404).send({ error: 'Card not found' });
+      }
+      const response = {
+        id: card.id,
+        title: card.title,
+        owner: {
+          username: card.user.username,
+          displayName: card.user.displayName,
+          bio: card.user.bio,
+          avatarUrl: card.user.avatarUrl,
+          accentColor: card.user.accentColor,
         },
-      },
-    });
-
-    if (!card) {
-      return _reply.status(404).send({ error: 'Card not found' });
-    }
-
-    const response: CardPublicProfileResponse = {
-      id: card.id,
-      title: card.title,
-      owner: {
-        username: card.user.username,
-        displayName: card.user.displayName,
-        bio: card.user.bio,
-        avatarUrl: card.user.avatarUrl,
-        accentColor: card.user.accentColor,
-      },
-      links: card.cardLinks.map((cl: CardLinkWithPlatform) => ({
-        id: cl.platformLink.id,
-        platform: cl.platformLink.platform,
-        username: cl.platformLink.username,
-        url: cl.platformLink.url,
-      })),
+        links: card.cardLinks.map((cl: any) => ({
+          id: cl.platformLink.id,
+          platform: cl.platformLink.platform,
+          username: cl.platformLink.username,
+          url: cl.platformLink.url,
+        })),
+      };
+      return response;
+    } catch (err: unknown) {
+      app.log.error({ err }, 'Failed to fetch shared card');
+      return reply.status(500).send({ error: 'Internal server error' });
     }
-
-    return response; 
-
   });
 
   // ─── Public Card View ─────────────────────────────────────────────────────
@@ -226,38 +117,30 @@ export async function publicRoutes(app: FastifyInstance): Promise<void> {
     const { username, cardId } = request.params;
 
     let viewerId: string | null = null;
-    let isSelfView = false;
+    let authenticatedUserId: string | null = null;
     try {
       if (request.headers.authorization) {
         const decoded = (await request.jwtVerify()) as { id?: string };
-        if (decoded?.id === user.id) {
-          isSelfView = true;
-        } else {
-          viewerId = decoded?.id ?? null;
-        }
+        authenticatedUserId = decoded?.id ?? null;
+        viewerId = authenticatedUserId;
       }
-    } catch (_e) {
-      // Ignored if invalid token
+    } catch {
+      // ignored
     }
 
-    if (!isSelfView && viewerId !== user.id) {
-      app.prisma.cardView.create({
-        data: {
-          ownerId: user.id,
-          cardId: card.id,
-          viewerId,
-          viewerIp: request.ip || null,
-          viewerAgent: request.headers['user-agent'] || null,
-          source: request.query?.source || 'qr',
-        },
-      }).catch((err: unknown) => app.log.error(`Failed to log view: ${getErrorMessage(err)}`));
+    try {
+      const result = await publicService.getUserCard(app, username, cardId, viewerId, request, authenticatedUserId);
+      if (result.notFound) {
+        return reply.status(404).send({ error: 'User or card not found' });
+      }
+      return result.data;
+    } catch (err: unknown) {
+      app.log.error({ err }, 'Failed to fetch user card');
+      return reply.status(500).send({ error: 'Internal server error' });
     }
   });
 
   // ─── QR Session ──────────────────────────────────────────────────────────
-  // Returns a short-lived signed JWT encoding the public profile snapshot.
-  // Intended for native apps to generate QR codes that remain scannable when
-  // the device has no live network connectivity (offline QR mode, spec §5.9).
   app.get('/:username/qr-session', {
     config: {
       rateLimit: {
@@ -269,7 +152,7 @@ export async function publicRoutes(app: FastifyInstance): Promise<void> {
     const { username } = request.params;
 
     try {
-      const result = await publicService.getPublicProfile(app, username, null, request);
+      const result = await publicService.getPublicProfile(app, username, null, request, null);
       if (!result) {
         return reply.status(404).send({ error: 'User not found' });
       }
@@ -290,7 +173,7 @@ export async function publicRoutes(app: FastifyInstance): Promise<void> {
   app.get('/:username/qr', {
     config: {
       rateLimit: {
-        max: 50, // Lower limit for QR generation as it's more resource intensive
+        max: 50,
         timeWindow: '1 minute'
       }
     } as FastifyContextConfig
@@ -301,9 +184,6 @@ export async function publicRoutes(app: FastifyInstance): Promise<void> {
     const { username } = request.params;
     const format = (request.query as any).format || 'png';
 
-    // Parse and validate size before touching the DB or allocating any buffers.
-    // parseInt safely handles non-numeric strings (returns NaN) and ignores any
-    // trailing fractional part, so '400.9' → 400 which is within bounds.
     const rawSize = (request.query as any).size;
     const size = rawSize !== undefined ? parseInt(rawSize, 10) : 400;
 
@@ -313,7 +193,6 @@ export async function publicRoutes(app: FastifyInstance): Promise<void> {
       });
     }
 
-    // Verify user exists
     const user = await app.prisma.user.findUnique({
       where: { username },
     });
@@ -343,4 +222,4 @@ export async function publicRoutes(app: FastifyInstance): Promise<void> {
       return reply.status(500).send({ error: 'QR code generation failed' });
     }
   });
-}
+}