@devdash/bofrid-api-types 0.1.5

package/dist/services/notifications/bibi-projects.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Central registry of Bofrid notification projects.
+ *
+ * Each entry's `project` value is passed to the Bibi `/api/events` endpoint
+ * (bibi.blpk.cc) which owns channel fan-out (push / email / discord).
+ */
+export interface BibiProjectConfig {
+    /** Bibi project name */
+    project: string;
+    /** Human-readable label */
+    label: string;
+    /** What events this project receives */
+    description: string;
+}
+export declare const BIBI_PROJECTS: {
+    readonly publications: {
+        readonly project: "bofrid-publications";
+        readonly label: "Publiceringar";
+        readonly description: "Publiceringsresultat (Blocket, Facebook, etc.)";
+    };
+    readonly approvals: {
+        readonly project: "bofrid-approvals";
+        readonly label: "Granskning";
+        readonly description: "Annons godkänd/nekad";
+    };
+    readonly alerts: {
+        readonly project: "bofrid-alerts";
+        readonly label: "Larm";
+        readonly description: "Kritiska systemlarm (e-postleverans, etc.)";
+    };
+    readonly emails: {
+        readonly project: "bofrid-emails";
+        readonly label: "E-postjobb";
+        readonly description: "E-postjobb livscykel (startat, klart, fel)";
+    };
+    readonly userActivity: {
+        readonly project: "bofrid-user-activity";
+        readonly label: "Användaraktivitet";
+        readonly description: "Inloggningar, registreringar och annan användaraktivitet";
+    };
+};
+/** Default project used by sendBibiEvent() when no project override is provided. */
+export declare const DEFAULT_BIBI_PROJECT: "bofrid-publications";

package/dist/services/notifications/bibi.d.ts

@@ -0,0 +1,229 @@
+/**
+ * Bibi (bibi.blpk.cc) notification dispatcher.
+ *
+ * Bibi's strict ingest split into POST /api/bugs (alert-worthy, signature-
+ * deduped) and POST /api/activity (append-only feed). The legacy /api/events
+ * endpoint was removed. As a stopgap, the 20 `bibiX(...)` wrappers below
+ * hand their structured payloads to `sendBibiEvent`, which POSTs to
+ * /api/ingest — Bibi's LLM router classifies each one into a bug or an
+ * activity row and dispatches channels accordingly.
+ *
+ * `sendActivity` is the direct sibling for the `/api/activity` feed (used
+ * by `bibi-logger` middleware and any route that already knows its event
+ * is informational).
+ *
+ * Fire-and-forget: never throws, logs errors to console.
+ */
+interface BibiEventOptions {
+    title: string;
+    message: string;
+    /** Legacy ntfy priority 1..5 — mapped to Bibi urgency */
+    priority?: 1 | 2 | 3 | 4 | 5;
+    tags?: string[];
+    click?: string;
+    /** Bibi project name (override; defaults to DEFAULT_BIBI_PROJECT) */
+    project?: string;
+}
+/**
+ * Send a push notification via Bibi (bibi.blpk.cc).
+ */
+export declare function sendBibiEvent(opts: BibiEventOptions): Promise<void>;
+/**
+ * Notify about a publication result (any channel).
+ */
+export declare function bibiPublicationResult(opts: {
+    channel: string;
+    listingId: string;
+    address: string;
+    success: boolean;
+    error?: string;
+    externalUrl?: string;
+    adminUrl?: string;
+}): Promise<void>;
+/**
+ * Notify about a user login.
+ */
+export declare function bibiUserLogin(opts: {
+    userName: string | null;
+    email: string | null;
+    method: string | null;
+}): Promise<void>;
+/**
+ * Notify about a new user signup.
+ */
+export declare function bibiNewUserSignup(opts: {
+    userName: string | null;
+    email: string;
+}): Promise<void>;
+/**
+ * Notify about a new bevakning (saved search) created.
+ */
+export declare function bibiBevakningCreated(opts: {
+    userName: string | null;
+    email?: string | null;
+    locationName: string;
+    source: "authenticated" | "guest";
+    origin?: string;
+}): Promise<void>;
+/**
+ * Notify about a new application submitted.
+ */
+export declare function bibiApplicationSubmitted(opts: {
+    tenantName: string;
+    address: string;
+    tier: string;
+}): Promise<void>;
+/**
+ * Notify about a contact reveal (landlord unlocked tenant info).
+ */
+export declare function bibiApplicationRevealed(opts: {
+    landlordName: string;
+    tenantName: string;
+    address: string;
+}): Promise<void>;
+/**
+ * Notify about a new chat conversation started.
+ */
+export declare function bibiConversationStarted(opts: {
+    landlordName: string;
+    tenantName: string;
+    address: string;
+}): Promise<void>;
+/**
+ * Notify about folkbokföring (population register) data imported.
+ */
+export declare function bibiFolkbokforingImported(opts: {
+    userName: string | null;
+    source: "hitta" | "nusvar" | "mrkoll";
+    entriesImported: number;
+}): Promise<void>;
+/**
+ * Track a Nusvar API call (paid external — bibi event for usage/cost tracking).
+ */
+export declare function bibiNusvarApiCalled(opts: {
+    userName: string | null;
+    outcome: "success" | "no_result" | "api_error" | "network_error";
+    entriesReturned?: number;
+    errorMessage?: string;
+}): Promise<void>;
+/**
+ * Notify about a reference being signed.
+ */
+export declare function bibiReferenceSigned(opts: {
+    receiverName: string | null;
+    signerName: string | null;
+    type: "housing" | "personal";
+}): Promise<void>;
+/**
+ * Notify about an upgrade checkout started.
+ */
+export declare function bibiUpgradeCheckoutStarted(opts: {
+    landlordName: string;
+    address: string;
+    priceOre: number;
+}): Promise<void>;
+/**
+ * Notify about a listing upgrade completed (payment confirmed).
+ */
+export declare function bibiListingUpgradeCompleted(opts: {
+    landlordName: string;
+    address: string;
+    priceOre: number;
+}): Promise<void>;
+/**
+ * Notify about a listing submitted for review.
+ */
+export declare function bibiListingReviewRequest(opts: {
+    landlordName: string;
+    address: string;
+    isResubmission: boolean;
+    adminUrl?: string;
+}): Promise<void>;
+/**
+ * Notify about a Homii auto-post result (triggered on listing approval).
+ */
+export declare function bibiHomiiAutoPost(opts: {
+    address: string;
+    listingId: string;
+    success: boolean;
+    homiiUrl?: string;
+    error?: string;
+}): Promise<void>;
+/**
+ * Notify about email job lifecycle events.
+ */
+export declare function bibiEmailJob(opts: {
+    event: "started" | "completed" | "failed" | "error";
+    jobId: string;
+    type: string;
+    totalItems?: number;
+    sentCount?: number;
+    failedCount?: number;
+    error?: string;
+    address?: string;
+}): Promise<void>;
+/**
+ * Notify when a user completes wizard step 1 (property created with address).
+ */
+export declare function bibiWizardStep1Completed(opts: {
+    userName: string | null;
+    address: string;
+    source: "authenticated" | "guest-flush";
+}): Promise<void>;
+/**
+ * Notify when a user completes wizard step 2 (map / coordinates set).
+ */
+export declare function bibiWizardStep2Completed(opts: {
+    userName: string | null;
+    address: string;
+}): Promise<void>;
+/**
+ * Notify about a listing approval decision.
+ */
+export declare function bibiListingApproval(opts: {
+    address: string;
+    landlordName: string;
+    decision: "approve" | "reject";
+    listingUrl?: string;
+    rejectionComment?: string;
+}): Promise<void>;
+/**
+ * Notify when a landlord starts a single-reveal checkout.
+ */
+export declare function bibiRevealCheckoutStarted(opts: {
+    landlordName: string;
+    priceOre: number;
+}): Promise<void>;
+/**
+ * Notify when a tenant starts a Boost checkout.
+ */
+export declare function bibiBoostCheckoutStarted(opts: {
+    tenantName: string;
+    plan: string;
+    priceOre: number;
+}): Promise<void>;
+/**
+ * Notify when admin gifts Boost to a tenant (free upgrade).
+ */
+export declare function bibiBoostGifted(opts: {
+    tenantName: string;
+    days: number;
+}): Promise<void>;
+/**
+ * Notify when a tenant's Boost subscription is canceled/deactivated.
+ */
+export declare function bibiBoostCanceled(opts: {
+    tenantName: string;
+    reason: string;
+}): Promise<void>;
+/**
+ * Send an informational activity event to the Bibi activity feed.
+ * Fire-and-forget — mirrors the client-side track() helper for server-side use.
+ */
+export declare function sendActivity(opts: {
+    kind: string;
+    title: string;
+    actor?: string | null;
+    context?: Record<string, unknown>;
+}): Promise<void>;
+export {};

package/dist/services/profiles/bankid-verify.d.ts

@@ -0,0 +1,23 @@
+/**
+ * BankID identity verification — extracted from profiles route for reuse
+ * by the auth/bankid poll endpoint.
+ */
+export interface BankIDUserData {
+    personnummer: string;
+    displayName: string;
+    givenName?: string;
+    surname?: string;
+}
+export interface BankIDVerifyResult {
+    profileId: string;
+    alreadyVerified: boolean;
+    merged: boolean;
+}
+/**
+ * Verify a user's identity via BankID data (personnummer + name).
+ *
+ * This is the same logic as the POST /profiles/bankid/verify route handler,
+ * extracted so the BankID QR poll endpoint can call it directly without
+ * going through an HTTP roundtrip.
+ */
+export declare function verifyBankIDIdentityDirect(profileId: string, authUserId: string, bankIDData: BankIDUserData): Promise<BankIDVerifyResult>;

package/dist/services/realtime.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Channel name convention: `conv:{conversationId}`.
+ * Server publishes, clients subscribe. The conversation-id namespace means
+ * a single subscription per open chat — no over-broadcast.
+ */
+export declare function conversationChannelName(conversationId: string): string;
+type ConversationEvent = "message:new" | "message:edited" | "message:deleted" | "conversation:archived" | "conversation:unarchived" | "conversation:unlocked" | "conversation:read";
+/**
+ * Fire-and-forget broadcast. Never throws — failures log and swallow,
+ * because the HTTP response has already been (or is about to be) sent.
+ * The polling fallback covers anything that doesn't land.
+ */
+export declare function broadcastConversationEvent(conversationId: string, event: ConversationEvent, payload: Record<string, unknown>): Promise<void>;
+export {};

package/dist/services/references/history-linker.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Reference History Linker Service
+ *
+ * Links verified references to housing history entries for bostadsmerit scoring.
+ * Internal service — called by reference signing handlers.
+ */
+/**
+ * Mark housing history entries as verified when a housing reference is signed.
+ * Verifies ALL entries at the same address (street + city).
+ */
+export declare function linkVerifiedReference(userId: string, _referenceType: "housing", sourceId: string, referenceId?: string, landlordData?: {
+    name?: string;
+    phone?: string;
+    email?: string;
+}): Promise<void>;
+/**
+ * Reset housing history verification when a housing reference is deleted.
+ */
+export declare function unlinkVerifiedReference(userId: string, _referenceType: "housing", sourceId: string): Promise<void>;

package/dist/services/tenant-boost/constants.d.ts

@@ -0,0 +1,120 @@
+/**
+ * Tenant Boost — Single source of truth for offer, pricing, limits, and copy.
+ *
+ * All Boost-related values live here so the API, frontend, and marketing
+ * pages can reference the same numbers and text without drift.
+ */
+export type BoostPlanId = "monthly" | "quarterly" | "halfyear";
+export interface BoostPlan {
+    id: BoostPlanId;
+    /** Price per month in öre */
+    pricePerMonthOre: number;
+    /** Total charged per billing cycle in öre */
+    totalOre: number;
+    /** Stripe recurring interval */
+    stripeInterval: "month";
+    /** Stripe interval_count (1, 3, or 6) */
+    stripeIntervalCount: number;
+    /** Display labels */
+    label: {
+        sv: string;
+        en: string;
+    };
+    /** Per-month display */
+    priceLabel: {
+        sv: string;
+        en: string;
+    };
+    /** Total per billing cycle display */
+    totalLabel: {
+        sv: string;
+        en: string;
+    };
+    /** Savings vs monthly (percentage) */
+    savingsPercent: number;
+}
+export declare const BOOST_PLANS: readonly BoostPlan[];
+/** Default plan used when none specified */
+export declare const DEFAULT_BOOST_PLAN: BoostPlanId;
+/** Introductory price for the first 3 days of Boost (39 SEK) */
+export declare const BOOST_TRIAL_PRICE_ORE = 3900;
+/** Number of trial days at the intro price */
+export declare const BOOST_TRIAL_DAYS = 3;
+/** Stripe product metadata value used in webhooks to identify Boost */
+export declare const BOOST_STRIPE_TYPE: "tenant_boost";
+/** Resolve a plan by ID (falls back to monthly) */
+export declare function getBoostPlan(planId?: string): BoostPlan;
+/**
+ * Added to the base tier score when the tenant has Boost.
+ * Sorts Boost tenants above non-Boost within the same tier
+ * without jumping to the next tier.
+ *
+ * Base scores: basic=1, standard=2, premium=3, super_premium=4
+ * With Boost:  basic=1.5, standard=2.5, premium=3.5, super_premium=4.5
+ */
+export declare const BOOST_TIER_SCORE_BONUS = 0.5;
+export declare const BOOST_FEATURES: readonly ["priority_placement", "direct_message", "read_receipts"];
+export type BoostFeature = (typeof BOOST_FEATURES)[number];
+export declare const BOOST_COPY: {
+    /** Product name */
+    readonly name: {
+        readonly sv: "Bofrid Boost";
+        readonly en: "Bofrid Boost";
+    };
+    /** Tagline — used in hero sections and upgrade prompts */
+    readonly tagline: {
+        readonly sv: "Öka dina chanser att hitta bostad";
+        readonly en: "Increase your chances of finding a home";
+    };
+    /** Short pitch — 1 sentence */
+    readonly pitch: {
+        readonly sv: "Sluta vänta — skriv direkt till hyresvärden och hamna högre i listan.";
+        readonly en: "Stop waiting — message the landlord directly and rank higher in the list.";
+    };
+    /** Price label — shows cheapest plan (half-year) */
+    readonly priceLabel: {
+        readonly sv: "289 kr/mån";
+        readonly en: "289 SEK/mo";
+    };
+    /** CTA button text */
+    readonly cta: {
+        readonly sv: "Prova i 3 dagar för 39 kr";
+        readonly en: "Try 3 days for 39 SEK";
+    };
+    /** Trial info shown below CTA */
+    readonly trialInfo: {
+        readonly sv: "39 kr de 3 första dagarna, sedan 289 kr/mån. Avsluta när du vill.";
+        readonly en: "39 SEK for the first 3 days, then 289 SEK/mo. Cancel anytime.";
+    };
+    /** Cancel info */
+    readonly cancelInfo: {
+        readonly sv: "Avsluta när du vill. Inga bindningstider.";
+        readonly en: "Cancel anytime. No commitment.";
+    };
+    /** Feature list — ordered by value (direct_message first = hero feature) */
+    readonly features: readonly [{
+        readonly key: "direct_message";
+        readonly sv: "Skriv direkt till hyresvärden";
+        readonly en: "Message the landlord directly";
+    }, {
+        readonly key: "priority_placement";
+        readonly sv: "Hamna högre i hyresvärdars listor";
+        readonly en: "Rank higher in landlord lists";
+    }, {
+        readonly key: "read_receipts";
+        readonly sv: "Se när hyresvärden sett din ansökan";
+        readonly en: "See when landlords view your application";
+    }];
+    /** Upgrade prompts — contextual copy shown in the boost flow */
+    readonly prompts: {
+        readonly directMessage: {
+            readonly sv: "Uppgradera till Boost för att skicka meddelande direkt till hyresvärden.";
+            readonly en: "Upgrade to Boost to message the landlord directly.";
+        };
+        readonly searchResults: {
+            readonly sv: "Boost-medlemmar hamnar högre i hyresvärdars kandidatlistor.";
+            readonly en: "Boost members rank higher in landlord candidate lists.";
+        };
+    };
+};
+export declare const FREE_TENANT_FEATURES: readonly ["profile_creation", "bankid_verification", "document_uploads", "search_and_browse", "chat_after_reveal", "appear_in_candidate_lists", "one_bevakning", "unlimited_applications"];

package/dist/services/tenant-boost/tenant-boost.service.d.ts

@@ -0,0 +1,59 @@
+/**
+ * Tenant Boost Service — Stripe subscription management.
+ *
+ * Handles Checkout creation, webhook lifecycle, and subscription queries.
+ * Boost subscriptions live on individual profiles (never companies).
+ */
+import type Stripe from "stripe";
+import type { BoostPlanId } from "./constants";
+/**
+ * Create a Stripe Checkout session for Tenant Boost subscription.
+ * Returns existing subscription info if already active.
+ */
+export declare function createBoostCheckout(userId: string, returnUrl: string, planId?: BoostPlanId): Promise<{
+    alreadySubscribed: true;
+    boostExpiresAt: string;
+} | {
+    checkoutUrl: string;
+}>;
+/**
+ * Handle `checkout.session.completed` for Boost subscriptions.
+ * Activates Boost on the tenant's profile.
+ */
+export declare function completeBoostCheckout(session: Stripe.Checkout.Session): Promise<void>;
+/**
+ * Handle subscription lifecycle events:
+ * - `customer.subscription.updated` — renewal, cancellation scheduled, plan change
+ * - `customer.subscription.deleted` — subscription ended (cancelled or payment failed)
+ */
+export declare function handleBoostSubscriptionEvent(subscription: Stripe.Subscription): Promise<void>;
+export interface BoostStatus {
+    active: boolean;
+    expiresAt: string | null;
+    cancelAtPeriodEnd: boolean;
+    subscriptionId: string | null;
+    status: 'trialing' | 'active' | 'inactive';
+    trialEnd: string | null;
+}
+/**
+ * Get the current Boost status for a user.
+ * Stripe subscription is the source of truth — always checks live status
+ * when a subscription ID exists and syncs DB accordingly.
+ */
+export declare function getBoostStatus(userId: string): Promise<BoostStatus>;
+/**
+ * Admin gift: grant Boost to a tenant for `days` days without Stripe.
+ *
+ * Sets isBoosted=true and boostExpiresAt = max(existing, now + days), so
+ * stacking a gift on top of a paid sub or a longer existing gift never
+ * shortens the user's coverage. boostStripeSubscriptionId is left untouched
+ * — getBoostStatus continues to treat Stripe as source of truth when present.
+ *
+ * Side-effects: unlocks every currently-locked conversation involving this
+ * tenant (reveal_reason='tenant_boost'), same as a real subscription start.
+ */
+export declare function giftTenantBoost(userId: string, days: number): Promise<{
+    alreadyBoosted: boolean;
+    boostExpiresAt: string;
+    conversationsUnlocked: number;
+}>;

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@devdash/bofrid-api-types",
+  "version": "0.1.5",
+  "description": "TypeScript type definitions for the Bofrid API — Hono RPC AppType + route shapes. Consumed by bofrid-web.",
+  "private": false,
+  "license": "UNLICENSED",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/devdashco/bofrid-api.git",
+    "directory": "types-package"
+  },
+  "types": "./dist/routes/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/routes/index.d.ts"
+    },
+    "./*": {
+      "types": "./dist/*.d.ts"
+    }
+  },
+  "files": [
+    "dist/**/*.d.ts",
+    "README.md"
+  ]
+}