@devdash/bofrid-api-types 0.1.5

package/dist/routes/contact-reveals.d.ts

@@ -0,0 +1,102 @@
+import { OpenAPIHono } from "@hono/zod-openapi";
+import type { AppBindings } from "../app";
+declare const _routes: OpenAPIHono<AppBindings, {
+    "/contact-reveals/history": {
+        $get: {
+            input: {};
+            output: {
+                transactions: {
+                    description: string;
+                    type: "reveal" | "listing_upgrade";
+                    date: string;
+                    id: string;
+                    listingAddress: string;
+                    free: boolean;
+                    priceOre: number;
+                    source?: string | undefined;
+                    listingUpgraded?: boolean | undefined;
+                }[];
+                reveals: {
+                    id: string;
+                    revealedAt: string;
+                    source: string;
+                    tenantName: string;
+                    listingAddress: string;
+                    free: boolean;
+                    priceOre: number;
+                }[];
+            };
+            outputFormat: "json";
+            status: 200;
+        };
+    };
+} & {
+    "/contact-reveals/allowance": {
+        $get: {
+            input: {};
+            output: {
+                limit: number;
+                used: number;
+                remaining: number;
+                resetDate: string;
+            };
+            outputFormat: "json";
+            status: 200;
+        };
+    };
+} & {
+    "/contact-reveals/listing-upgrade/checkout": {
+        $post: {
+            input: {
+                json: {
+                    listingId: string;
+                    returnUrl: string;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 400;
+        } | {
+            input: {
+                json: {
+                    listingId: string;
+                    returnUrl: string;
+                };
+            };
+            output: {
+                alreadyUpgraded: true;
+            } | {
+                checkoutUrl: string;
+            };
+            outputFormat: "json";
+            status: 200;
+        };
+    };
+} & {
+    "/contact-reveals/listing-upgrade/:listingId": {
+        $get: {
+            input: {
+                param: {
+                    listingId: string;
+                };
+            };
+            output: {
+                tier: number | null;
+                priceOre: number;
+                upgraded: boolean;
+                priceDisplay: string;
+                isFirstListing: boolean;
+                discountPercent: number;
+                discountedPriceOre: number | null;
+                discountedPriceDisplay: string | null;
+            };
+            outputFormat: "json";
+            status: 200;
+        };
+    };
+}, "/">;
+export type ContactRevealsApp = typeof _routes;
+export declare const contactRevealsApp: OpenAPIHono<AppBindings, {}, "/">;
+export {};

package/dist/routes/conversations/handlers/conversation.d.ts

@@ -0,0 +1,5 @@
+import type { RouteHandler } from "@hono/zod-openapi";
+import type { AppBindings } from "../../../app";
+import type { getConversationRoute, listConversationsRoute } from "../routes";
+export declare const handleListConversations: RouteHandler<typeof listConversationsRoute, AppBindings>;
+export declare const handleGetConversation: RouteHandler<typeof getConversationRoute, AppBindings>;

package/dist/routes/conversations/handlers/initiate.d.ts

@@ -0,0 +1,4 @@
+import type { RouteHandler } from "@hono/zod-openapi";
+import type { AppBindings } from "../../../app";
+import type { initiateConversationRoute } from "../routes";
+export declare const handleInitiateConversation: RouteHandler<typeof initiateConversationRoute, AppBindings>;

package/dist/routes/conversations/handlers/messages.d.ts

@@ -0,0 +1,5 @@
+import type { RouteHandler } from "@hono/zod-openapi";
+import type { AppBindings } from "../../../app";
+import type { listMessagesRoute, sendMessageRoute } from "../routes";
+export declare const handleListMessages: RouteHandler<typeof listMessagesRoute, AppBindings>;
+export declare const handleSendMessage: RouteHandler<typeof sendMessageRoute, AppBindings>;

package/dist/routes/conversations/handlers/state.d.ts

@@ -0,0 +1,5 @@
+import type { RouteHandler } from "@hono/zod-openapi";
+import type { AppBindings } from "../../../app";
+import type { archiveConversationRoute, markReadRoute } from "../routes";
+export declare const handleMarkRead: RouteHandler<typeof markReadRoute, AppBindings>;
+export declare const handleArchiveConversation: RouteHandler<typeof archiveConversationRoute, AppBindings>;

package/dist/routes/conversations/helpers/access.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Check if a user can access a conversation.
+ * Access is granted if the user is a direct participant OR an active member
+ * of the company that owns the listing's property.
+ */
+export declare function verifyParticipant(conversationId: string, profileId: string): Promise<boolean>;
+/**
+ * Ensure a participant row exists for a user in a conversation.
+ * Used to lazily create participant records for company members on first interaction.
+ */
+export declare function ensureParticipant(conversationId: string, profileId: string): Promise<void>;

package/dist/routes/conversations/helpers/enrich-conversation.d.ts

@@ -0,0 +1,58 @@
+/**
+ * Build a single conversation list item with all enrichment.
+ * Used by both list and get-single handlers.
+ */
+export declare function enrichConversation(conv: {
+    id: string;
+    listingId: string;
+    tenantId: string;
+    landlordId: string;
+    isLocked: boolean;
+    createdAt: Date;
+    updatedAt: Date;
+    propertyId?: string | null;
+    street: string | null;
+    streetNumber: string | null;
+    city: string | null;
+    totalRooms?: number | null;
+    propertySize?: number | null;
+    publicUrl?: string | null;
+    publicUrlEn?: string | null;
+    upgradedAt?: Date | null;
+}, profileId: string, 
+/** Viewer-specific archived state; defaults to false if no participant row yet. */
+archived?: boolean): Promise<{
+    id: string;
+    listingId: string;
+    tenantId: string;
+    landlordId: string;
+    userRole: "tenant" | "landlord";
+    isLocked: boolean;
+    createdAt: string;
+    updatedAt: string;
+    otherParticipant: {
+        id: string;
+        displayName: string | null;
+        fullName: string | null;
+        profilePictureUrl: string | null;
+    };
+    listing: {
+        propertyId: string | null;
+        street: string | null;
+        streetNumber: string | null;
+        city: string | null;
+        totalRooms: number | null;
+        propertySize: number | null;
+        publicUrl: string | null;
+        publicUrlEn: string | null;
+        upgradedAt: string | null;
+    };
+    lastMessage: {
+        body: string;
+        senderId: string;
+        createdAt: string;
+    } | null;
+    unreadCount: number;
+    otherParticipantLastReadAt: string | null;
+    archived: boolean;
+}>;

package/dist/routes/conversations/helpers/identity.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Privacy masking rules for chat identities.
+ *
+ * Tenants viewing a private (non-company) landlord only ever see the landlord's
+ * first name — full name is never exposed to tenants in chat.
+ * Landlords viewing a tenant only see the first name while the chat is locked;
+ * unlocking reveals the full name.
+ * Company listings always render as the company name + logo (the landlord's
+ * personal identity is exposed only via `memberName` for landlord-side viewers).
+ *
+ * This is the SINGLE source of truth — `enrichConversation` and the message
+ * list handler both call into here. Drift across two copies would silently
+ * leak names; don't reimplement.
+ */
+export declare function firstNameOnly(name: string | null | undefined): string | null;
+export interface MaskIdentityArgs {
+    /** Role of the identity being rendered (NOT the viewer's role). */
+    subjectRole: "landlord" | "tenant";
+    /** Viewer's role in the conversation. */
+    viewerRole: "landlord" | "tenant";
+    /** Whether the listing is owned by a company. */
+    isCompanyListing: boolean;
+    /** Effective locked state (with upgradedAt override applied). */
+    isLocked: boolean;
+}
+export interface MaskedIdentity {
+    /** Show full personal name (or company name) as-is. */
+    showFullName: boolean;
+    /** Render company branding instead of personal identity. */
+    showAsCompany: boolean;
+}
+export declare function resolveIdentityMasking(args: MaskIdentityArgs): MaskedIdentity;
+/**
+ * Resolve a profile's display identity.
+ * When role is "tenant", always returns personal identity — the person is a
+ * separate legal entity from any company they may belong to.
+ * When role is "landlord" and the person is a company member, returns company identity.
+ */
+export declare function resolveSenderIdentity(profileId: string, role: "landlord" | "tenant", listingId?: string): Promise<{
+    displayName: string;
+    profilePictureUrl: string | null;
+    memberName: string | null;
+} | undefined>;

package/dist/routes/conversations/helpers/notify-recipient.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Send a "new message" email notification to the recipient if they had
+ * 0 unread messages before this one (i.e. they were "caught up").
+ * Runs fire-and-forget — never blocks the response.
+ *
+ * De-duplicates on `(conversationId, recipientId)` over a 60s window to
+ * absorb the unread-count race when two messages from the same sender land
+ * within milliseconds.
+ */
+export declare function notifyRecipientIfCaughtUp(conversationId: string, senderId: string, messageBody: string): void;

package/dist/routes/conversations/helpers/reconcile-reveal.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Self-heal drift: if chat is unlocked, the candidate must be revealed too.
+ * Covers legacy rows created before the apply-time reveal fix. Idempotent.
+ *
+ * Runs fire-and-forget: the handler doesn't await this, since the reconciled
+ * state only matters for downstream reveal queries and not for the immediate
+ * response. Cheap existence-check first so we don't issue two updates on the
+ * hot path when there is nothing to heal.
+ */
+export declare function reconcileChatReveal(conversationId: string, listingId: string, tenantId: string, isLocked: boolean): void;

package/dist/routes/conversations/helpers/scrub-contact.d.ts

@@ -0,0 +1 @@
+export declare function scrubContactInfo(body: string): string;

package/dist/routes/conversations/index.d.ts

@@ -0,0 +1,422 @@
+import { OpenAPIHono } from "@hono/zod-openapi";
+import type { AppBindings } from "../../app";
+export declare const conversationsApp: OpenAPIHono<AppBindings, {
+    "/conversations": {
+        $get: {
+            input: {
+                query: {
+                    filter?: "archived" | "all" | "unread" | undefined;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 401;
+        } | {
+            input: {
+                query: {
+                    filter?: "archived" | "all" | "unread" | undefined;
+                };
+            };
+            output: {
+                id: string;
+                createdAt: string;
+                updatedAt: string;
+                landlordId: string;
+                isLocked: boolean;
+                listingId: string;
+                tenantId: string;
+                archived: boolean;
+                listing: {
+                    street: string | null;
+                    streetNumber: string | null;
+                    city: string | null;
+                    propertySize: number | null;
+                    totalRooms: number | null;
+                    publicUrl: string | null;
+                    publicUrlEn: string | null;
+                    upgradedAt: string | null;
+                };
+                userRole: "tenant" | "landlord";
+                otherParticipant: {
+                    id: string;
+                    displayName: string | null;
+                    fullName: string | null;
+                    profilePictureUrl: string | null;
+                };
+                lastMessage: {
+                    body: string;
+                    createdAt: string;
+                    senderId: string;
+                } | null;
+                unreadCount: number;
+                otherParticipantLastReadAt: string | null;
+            }[];
+            outputFormat: "json";
+            status: 200;
+        };
+    };
+} & {
+    "/conversations/:id": {
+        $get: {
+            input: {
+                param: {
+                    id: string;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 401;
+        } | {
+            input: {
+                param: {
+                    id: string;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 404;
+        } | {
+            input: {
+                param: {
+                    id: string;
+                };
+            };
+            output: {
+                id: string;
+                createdAt: string;
+                updatedAt: string;
+                landlordId: string;
+                isLocked: boolean;
+                listingId: string;
+                tenantId: string;
+                archived: boolean;
+                listing: {
+                    street: string | null;
+                    streetNumber: string | null;
+                    city: string | null;
+                    propertySize: number | null;
+                    totalRooms: number | null;
+                    publicUrl: string | null;
+                    publicUrlEn: string | null;
+                    upgradedAt: string | null;
+                };
+                userRole: "tenant" | "landlord";
+                otherParticipant: {
+                    id: string;
+                    displayName: string | null;
+                    fullName: string | null;
+                    profilePictureUrl: string | null;
+                };
+                lastMessage: {
+                    body: string;
+                    createdAt: string;
+                    senderId: string;
+                } | null;
+                unreadCount: number;
+                otherParticipantLastReadAt: string | null;
+            };
+            outputFormat: "json";
+            status: 200;
+        };
+    };
+} & {
+    "/conversations/:id/messages": {
+        $get: {
+            input: {
+                param: {
+                    id: string;
+                };
+            } & {
+                query: {
+                    limit?: number | undefined;
+                    cursor?: string | undefined;
+                    since?: string | undefined;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 401;
+        } | {
+            input: {
+                param: {
+                    id: string;
+                };
+            } & {
+                query: {
+                    limit?: number | undefined;
+                    cursor?: string | undefined;
+                    since?: string | undefined;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 404;
+        } | {
+            input: {
+                param: {
+                    id: string;
+                };
+            } & {
+                query: {
+                    limit?: number | undefined;
+                    cursor?: string | undefined;
+                    since?: string | undefined;
+                };
+            };
+            output: {
+                messages: {
+                    type: string;
+                    body: string;
+                    id: string;
+                    createdAt: string;
+                    conversationId: string;
+                    senderId: string;
+                    editedAt: string | null;
+                    deletedAt: string | null;
+                    senderRole: "tenant" | "landlord";
+                    sender?: {
+                        displayName: string | null;
+                        profilePictureUrl: string | null;
+                        memberName: string | null;
+                    } | undefined;
+                    clientMessageId?: string | null | undefined;
+                }[];
+                nextCursor: string | null;
+            };
+            outputFormat: "json";
+            status: 200;
+        };
+    };
+} & {
+    "/conversations/:id/messages": {
+        $post: {
+            input: {
+                param: {
+                    id: string;
+                };
+            } & {
+                json: {
+                    body: string;
+                    clientMessageId?: string | undefined;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 401;
+        } | {
+            input: {
+                param: {
+                    id: string;
+                };
+            } & {
+                json: {
+                    body: string;
+                    clientMessageId?: string | undefined;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 404;
+        } | {
+            input: {
+                param: {
+                    id: string;
+                };
+            } & {
+                json: {
+                    body: string;
+                    clientMessageId?: string | undefined;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 403;
+        } | {
+            input: {
+                param: {
+                    id: string;
+                };
+            } & {
+                json: {
+                    body: string;
+                    clientMessageId?: string | undefined;
+                };
+            };
+            output: {
+                type: string;
+                body: string;
+                id: string;
+                createdAt: string;
+                conversationId: string;
+                senderId: string;
+                editedAt: string | null;
+                deletedAt: string | null;
+                senderRole: "tenant" | "landlord";
+                sender?: {
+                    displayName: string | null;
+                    profilePictureUrl: string | null;
+                    memberName: string | null;
+                } | undefined;
+                clientMessageId?: string | null | undefined;
+            };
+            outputFormat: "json";
+            status: 201;
+        };
+    };
+} & {
+    "/conversations/:id/read": {
+        $post: {
+            input: {
+                param: {
+                    id: string;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 401;
+        } | {
+            input: {
+                param: {
+                    id: string;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 404;
+        } | {
+            input: {
+                param: {
+                    id: string;
+                };
+            };
+            output: {
+                success: boolean;
+            };
+            outputFormat: "json";
+            status: 200;
+        };
+    };
+} & {
+    "/conversations/:id/archive": {
+        $post: {
+            input: {
+                param: {
+                    id: string;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 401;
+        } | {
+            input: {
+                param: {
+                    id: string;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 404;
+        } | {
+            input: {
+                param: {
+                    id: string;
+                };
+            };
+            output: {
+                archived: boolean;
+            };
+            outputFormat: "json";
+            status: 200;
+        };
+    };
+} & {
+    "/conversations/initiate": {
+        $post: {
+            input: {
+                json: {
+                    listingId: string;
+                    message?: string | undefined;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 401;
+        } | {
+            input: {
+                json: {
+                    listingId: string;
+                    message?: string | undefined;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 404;
+        } | {
+            input: {
+                json: {
+                    listingId: string;
+                    message?: string | undefined;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 403;
+        } | {
+            input: {
+                json: {
+                    listingId: string;
+                    message?: string | undefined;
+                };
+            };
+            output: {
+                conversationId: string;
+                created: boolean;
+            };
+            outputFormat: "json";
+            status: 200;
+        } | {
+            input: {
+                json: {
+                    listingId: string;
+                    message?: string | undefined;
+                };
+            };
+            output: {
+                conversationId: string;
+                created: boolean;
+            };
+            outputFormat: "json";
+            status: 201;
+        };
+    };
+}, "/">;