Matt
31ba72f344
Ship-what's-done prep ahead of the prod cutover (launch ~today): - Hide Financial + Marketing report cards from the reports landing (both were "Builder in development" placeholders gated on unbuilt data sources). Sales/Operational/Custom + templates/scheduling/ exports remain live. - Trim the Custom-report card copy to match the shipped basic builder (no group-by/filters yet; the builder page header was already honest). - Hide the Bulk Import mockup from search-nav-catalog + the admin sections browser; /admin/import is now unreachable from the UI. - Correct client-facing doc over-claims (waiting-list "next-in-line notification", Import) in features-list.md + new-system-feature-summary.md. - Un-stale BACKLOG.md (Documenso phases 2-7 confirmed shipped). - Log decisions + deferred work (full importer, full custom-builder, waiting-list, maintenance-log, paper-upload bug) to launch-readiness.md. Deferred-importer design spec added at docs/superpowers/specs/2026-06-01-bulk-import-design.md. Verified: tsc --noEmit clean, eslint clean on changed files, 1512/1519 vitest pass (7 failures are Redis-down, unrelated). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
504 lines
15 KiB
TypeScript
504 lines
15 KiB
TypeScript
/**
|
|
* Static catalog of navigation destinations the global search bar can jump
|
|
* to: settings pages, admin panels, and top-level dashboards.
|
|
*
|
|
* Each entry has an `href` template (run through `resolveHref` with the
|
|
* current portSlug), a human label, and a list of keyword aliases. The
|
|
* search service substring-matches the query against the label + every
|
|
* keyword, so `smtp` lands on the email settings page even though the
|
|
* label reads "Email accounts".
|
|
*
|
|
* Why hardcoded vs introspecting routes? The catalog is curated - only
|
|
* pages worth jumping to from a global search appear here, and each
|
|
* entry has hand-picked keyword synonyms that route inference can't
|
|
* derive. Adding a route to the catalog is cheap; misfiring routes are
|
|
* expensive.
|
|
*/
|
|
|
|
import type { RolePermissions } from '@/lib/db/schema/users';
|
|
|
|
export type NavCatalogCategory = 'settings' | 'admin' | 'dashboard';
|
|
|
|
export interface NavCatalogEntry {
|
|
/** Path template - `:portSlug` is substituted at lookup time. */
|
|
href: string;
|
|
label: string;
|
|
category: NavCatalogCategory;
|
|
/** Lowercase aliases - query is matched against label + these. */
|
|
keywords: string[];
|
|
/**
|
|
* Permission gate; only shown to users whose `RolePermissions` resolves
|
|
* truthy at the given dot-path (e.g. `'admin.manage_users'`). Super
|
|
* admins bypass the gate.
|
|
*/
|
|
requires?: string;
|
|
/** When set, only super admins see the entry. */
|
|
superAdminOnly?: boolean;
|
|
}
|
|
|
|
export const NAV_CATALOG: NavCatalogEntry[] = [
|
|
// ─── Dashboards ─────────────────────────────────────────────────────────
|
|
{
|
|
href: '/:portSlug/dashboard',
|
|
label: 'Dashboard',
|
|
category: 'dashboard',
|
|
keywords: ['home', 'overview', 'kpis', 'metrics'],
|
|
},
|
|
{
|
|
href: '/:portSlug/website-analytics',
|
|
label: 'Website analytics',
|
|
category: 'dashboard',
|
|
keywords: ['umami', 'traffic', 'visitors', 'pageviews', 'marketing'],
|
|
},
|
|
|
|
// ─── Settings ───────────────────────────────────────────────────────────
|
|
{
|
|
href: '/:portSlug/settings',
|
|
label: 'Settings',
|
|
category: 'settings',
|
|
keywords: ['preferences', 'configuration', 'config'],
|
|
},
|
|
// The granular settings cards below redirect to the `/admin/<x>` routes
|
|
// that actually exist - the catalog previously listed `/settings/<x>`
|
|
// paths that have never had route folders. We keep the keyword aliases
|
|
// so the cmd-K search still finds them under the right destination.
|
|
{
|
|
href: '/:portSlug/admin/email',
|
|
label: 'Email accounts (SMTP / IMAP)',
|
|
category: 'settings',
|
|
keywords: [
|
|
'smtp',
|
|
'imap',
|
|
'mail',
|
|
'mail server',
|
|
'email credentials',
|
|
'send-from',
|
|
'inbox',
|
|
'bounces',
|
|
],
|
|
requires: 'admin.manage_settings',
|
|
},
|
|
{
|
|
href: '/:portSlug/admin/branding',
|
|
label: 'Branding (per-port logo, colors, copy)',
|
|
category: 'settings',
|
|
keywords: ['logo', 'theme', 'colors', 'tenant brand', 'white-label'],
|
|
requires: 'admin.manage_settings',
|
|
},
|
|
{
|
|
href: '/:portSlug/admin/templates',
|
|
label: 'Document templates',
|
|
category: 'settings',
|
|
keywords: [
|
|
'eoi',
|
|
'documenso',
|
|
'pdf templates',
|
|
'email templates',
|
|
'template merge fields',
|
|
'merge fields',
|
|
'eoi template',
|
|
],
|
|
requires: 'admin.manage_settings',
|
|
},
|
|
{
|
|
href: '/:portSlug/admin/storage',
|
|
label: 'File storage backend',
|
|
category: 'settings',
|
|
keywords: ['s3', 'minio', 'filesystem', 'storage'],
|
|
requires: 'admin.manage_settings',
|
|
},
|
|
{
|
|
href: '/:portSlug/admin/settings',
|
|
label: 'Berth recommender weights',
|
|
category: 'settings',
|
|
keywords: ['ranking', 'tier ladder', 'heat', 'fallthrough', 'recommend'],
|
|
requires: 'admin.manage_settings',
|
|
},
|
|
{
|
|
href: '/:portSlug/admin/tags',
|
|
label: 'Tags',
|
|
category: 'settings',
|
|
keywords: ['labels', 'categories', 'classification'],
|
|
},
|
|
{
|
|
href: '/:portSlug/settings',
|
|
label: 'Notification preferences',
|
|
category: 'settings',
|
|
keywords: ['alerts', 'email digest', 'in-app', 'push', 'reminders digest'],
|
|
},
|
|
{
|
|
href: '/:portSlug/settings',
|
|
label: 'My profile & preferences',
|
|
category: 'settings',
|
|
keywords: [
|
|
'profile',
|
|
'avatar',
|
|
'display name',
|
|
'full name',
|
|
'phone',
|
|
'timezone',
|
|
'locale',
|
|
'country',
|
|
'dark mode',
|
|
'theme',
|
|
'password',
|
|
'change email',
|
|
'security',
|
|
'account',
|
|
'me',
|
|
],
|
|
},
|
|
{
|
|
href: '/:portSlug/dashboard?customize=1',
|
|
label: 'Customize dashboard widgets',
|
|
category: 'settings',
|
|
keywords: ['widgets', 'tiles', 'dashboard layout', 'kpi', 'reorder widgets'],
|
|
},
|
|
|
|
// ─── Admin ──────────────────────────────────────────────────────────────
|
|
{
|
|
href: '/:portSlug/admin',
|
|
label: 'Administration',
|
|
category: 'admin',
|
|
keywords: ['admin'],
|
|
requires: 'admin.manage_users',
|
|
},
|
|
{
|
|
href: '/:portSlug/admin/users',
|
|
label: 'Users & roles',
|
|
category: 'admin',
|
|
keywords: [
|
|
'accounts',
|
|
'permissions',
|
|
'invites',
|
|
'invitations',
|
|
'pending invites',
|
|
'onboarding',
|
|
'team',
|
|
'staff',
|
|
'roles',
|
|
],
|
|
requires: 'admin.manage_users',
|
|
},
|
|
{
|
|
href: '/:portSlug/admin/audit',
|
|
label: 'Audit log',
|
|
category: 'admin',
|
|
keywords: ['activity', 'history', 'events', 'who did what', 'compliance'],
|
|
requires: 'admin.view_audit_log',
|
|
},
|
|
{
|
|
href: '/:portSlug/admin/berths',
|
|
label: 'Berths admin',
|
|
category: 'admin',
|
|
keywords: ['bulk add berths', 'reconcile berths', 'berth pdf', 'mooring', 'bulk'],
|
|
requires: 'admin.manage_settings',
|
|
},
|
|
{
|
|
href: '/:portSlug/admin/inquiries',
|
|
label: 'Website inquiries inbox',
|
|
category: 'admin',
|
|
keywords: ['enquiries', 'leads', 'contact form', 'eoi requests', 'website'],
|
|
},
|
|
{
|
|
href: '/:portSlug/admin/errors',
|
|
label: 'Platform errors',
|
|
category: 'admin',
|
|
keywords: ['errors', 'exceptions', 'incidents', 'failures'],
|
|
superAdminOnly: true,
|
|
},
|
|
|
|
// ─── Admin → granular section cards (the AdminSectionsBrowser groups) ────
|
|
// These deep-link to specific admin sub-pages. Each one's `keywords`
|
|
// mirrors the corresponding entry in src/components/admin/
|
|
// admin-sections-browser.tsx - so typing a setting key in the topbar
|
|
// global search finds the same card the in-admin search would.
|
|
{
|
|
href: '/:portSlug/admin/settings',
|
|
label: 'System Settings',
|
|
category: 'admin',
|
|
keywords: [
|
|
'feature flags',
|
|
'feature flag',
|
|
'client portal',
|
|
'client portal enabled',
|
|
'tenancies',
|
|
'tenancies module',
|
|
'tenancy',
|
|
'tenancy tracker',
|
|
'lease',
|
|
'lease windows',
|
|
'renewals',
|
|
'transfers',
|
|
'expenses',
|
|
'expenses module',
|
|
'receipts',
|
|
'expense receipts',
|
|
'ai',
|
|
'ai interest scoring',
|
|
'ai email drafts',
|
|
'invoice net10 discount',
|
|
'net-10',
|
|
'pipeline weights',
|
|
'pipeline stage weights',
|
|
'forecast',
|
|
'berth rules',
|
|
'berth status rules',
|
|
'inquiry contact email',
|
|
'inquiry notification recipients',
|
|
'residential notification recipients',
|
|
'eoi signers',
|
|
'developer',
|
|
'approver',
|
|
'countersign',
|
|
'recommender max oversize',
|
|
'recommender top n',
|
|
'recommender default count',
|
|
'fallthrough policy',
|
|
'fallthrough cooldown',
|
|
'heat weight recency',
|
|
'heat weight furthest stage',
|
|
'heat weight interest count',
|
|
'heat weight eoi count',
|
|
'tier ladder',
|
|
'hide late stage',
|
|
'documents show expired tab',
|
|
'expired tab',
|
|
'berths default currency',
|
|
'default currency',
|
|
],
|
|
requires: 'admin.manage_settings',
|
|
},
|
|
{
|
|
href: '/:portSlug/admin/branding',
|
|
label: 'Branding',
|
|
category: 'admin',
|
|
keywords: ['logo', 'app name', 'theme', 'colors', 'email header', 'white-label'],
|
|
requires: 'admin.manage_settings',
|
|
},
|
|
{
|
|
href: '/:portSlug/admin/email',
|
|
label: 'Email settings',
|
|
category: 'admin',
|
|
keywords: ['smtp', 'imap', 'mail', 'from address', 'signature', 'mail server'],
|
|
requires: 'admin.manage_settings',
|
|
},
|
|
{
|
|
href: '/:portSlug/admin/documenso',
|
|
label: 'EOI signing service',
|
|
category: 'admin',
|
|
keywords: ['documenso', 'signing', 'eoi', 'api credentials', 'webhook secret'],
|
|
requires: 'admin.manage_settings',
|
|
},
|
|
{
|
|
href: '/:portSlug/admin/reminders',
|
|
label: 'Reminder settings',
|
|
category: 'admin',
|
|
keywords: ['reminders', 'daily digest', 'delivery window'],
|
|
requires: 'admin.manage_settings',
|
|
},
|
|
{
|
|
href: '/:portSlug/admin/webhooks',
|
|
label: 'Webhooks',
|
|
category: 'admin',
|
|
keywords: ['webhook', 'outgoing', 'callback', 'delivery log'],
|
|
requires: 'admin.manage_webhooks',
|
|
},
|
|
{
|
|
href: '/:portSlug/admin/forms',
|
|
label: 'Forms',
|
|
category: 'admin',
|
|
keywords: ['form templates', 'inquiry', 'intake', 'public form'],
|
|
requires: 'admin.manage_forms',
|
|
},
|
|
{
|
|
href: '/:portSlug/admin/email-templates',
|
|
label: 'Email templates',
|
|
category: 'admin',
|
|
keywords: ['transactional emails', 'subject lines', 'portal email', 'inquiry email'],
|
|
requires: 'admin.manage_settings',
|
|
},
|
|
{
|
|
href: '/:portSlug/admin/tags',
|
|
label: 'Tags',
|
|
category: 'admin',
|
|
keywords: ['labels', 'color-coded', 'classification'],
|
|
requires: 'admin.manage_tags',
|
|
},
|
|
{
|
|
href: '/:portSlug/admin/vocabularies',
|
|
label: 'Vocabularies',
|
|
category: 'admin',
|
|
keywords: [
|
|
'pick lists',
|
|
'interest temperatures',
|
|
'status reasons',
|
|
'tenure types',
|
|
'expense categories',
|
|
'document types',
|
|
],
|
|
requires: 'admin.manage_settings',
|
|
},
|
|
{
|
|
href: '/:portSlug/admin/custom-fields',
|
|
label: 'Custom fields',
|
|
category: 'admin',
|
|
keywords: ['custom fields', 'tenant fields', 'extra fields'],
|
|
requires: 'admin.manage_custom_fields',
|
|
},
|
|
{
|
|
href: '/:portSlug/admin/duplicates',
|
|
label: 'Duplicates queue',
|
|
category: 'admin',
|
|
keywords: ['dedup', 'duplicate clients', 'merge', 'review queue'],
|
|
},
|
|
{
|
|
href: '/:portSlug/admin/sends',
|
|
label: 'Send log',
|
|
category: 'admin',
|
|
keywords: ['email sends', 'brochures', 'send failures', 'retries'],
|
|
},
|
|
{
|
|
href: '/:portSlug/admin/monitoring',
|
|
label: 'Queue monitoring',
|
|
category: 'admin',
|
|
keywords: ['bullmq', 'queue', 'jobs', 'throughput', 'retries'],
|
|
requires: 'admin.system_backup',
|
|
},
|
|
{
|
|
href: '/:portSlug/admin/backup',
|
|
label: 'Backup & restore',
|
|
category: 'admin',
|
|
keywords: ['backup', 'restore', 'retention', 'disaster recovery'],
|
|
requires: 'admin.system_backup',
|
|
},
|
|
{
|
|
href: '/:portSlug/admin/storage',
|
|
label: 'Storage backend',
|
|
category: 'admin',
|
|
keywords: ['s3', 'minio', 'filesystem', 'storage backend', 'object store'],
|
|
requires: 'admin.system_backup',
|
|
},
|
|
{
|
|
href: '/:portSlug/admin/ports',
|
|
label: 'Ports',
|
|
category: 'admin',
|
|
keywords: ['marinas', 'tenancy', 'port management', 'multi-port'],
|
|
superAdminOnly: true,
|
|
},
|
|
{
|
|
href: '/:portSlug/admin/ai',
|
|
label: 'AI configuration',
|
|
category: 'admin',
|
|
keywords: ['openai', 'anthropic', 'gpt', 'claude', 'llm', 'api key', 'embeddings'],
|
|
requires: 'admin.manage_settings',
|
|
},
|
|
// /admin/ocr collapsed into /admin/ai on 2026-05-22 (the OcrSettingsForm
|
|
// already lived on both pages). Keywords surfaced via the AI tile.
|
|
{
|
|
href: '/:portSlug/admin/website-analytics',
|
|
label: 'Website analytics (Umami)',
|
|
category: 'admin',
|
|
keywords: ['umami', 'analytics', 'traffic', 'visitors', 'marketing', 'pageviews'],
|
|
requires: 'admin.manage_settings',
|
|
},
|
|
{
|
|
href: '/:portSlug/admin/residential-stages',
|
|
label: 'Residential pipeline stages',
|
|
category: 'admin',
|
|
keywords: ['residential stages', 'pipeline', 'residential funnel'],
|
|
requires: 'admin.manage_settings',
|
|
},
|
|
{
|
|
href: '/:portSlug/admin/roles',
|
|
label: 'Roles & permissions',
|
|
category: 'admin',
|
|
keywords: ['roles', 'permissions', 'access control', 'rbac'],
|
|
requires: 'admin.manage_users',
|
|
},
|
|
// /admin/invitations was merged into /admin/users on 2026-05-21 - the
|
|
// standalone catalog entry would route to the redirect stub. Reps
|
|
// searching for "invite" still land on the right surface via the
|
|
// /admin/users keyword list (extended below).
|
|
];
|
|
|
|
/** Substitute `:portSlug` placeholder for the current port. */
|
|
export function resolveHref(href: string, portSlug: string): string {
|
|
return href.replace(':portSlug', portSlug);
|
|
}
|
|
|
|
/**
|
|
* Returns nav catalog entries matching the query, filtered by what the
|
|
* current user is allowed to see. Match is a substring check against
|
|
* label + each keyword; ranking favors label hits over keyword hits and
|
|
* prefix hits over mid-string hits.
|
|
*
|
|
* Pure / sync - runs in-process. The catalog is ~15 entries today, so
|
|
* the linear scan is irrelevant cost-wise.
|
|
*/
|
|
export function searchNavCatalog(
|
|
query: string,
|
|
opts: { isSuperAdmin: boolean; permissions: RolePermissions | null; limit?: number },
|
|
): Array<NavCatalogEntry & { score: number }> {
|
|
const q = query.trim().toLowerCase();
|
|
if (q.length === 0) return [];
|
|
|
|
const limit = opts.limit ?? 5;
|
|
const byHref = new Map<string, NavCatalogEntry & { score: number }>();
|
|
|
|
for (const entry of NAV_CATALOG) {
|
|
if (entry.superAdminOnly && !opts.isSuperAdmin) continue;
|
|
if (entry.requires && !opts.isSuperAdmin && !hasPermission(opts.permissions, entry.requires)) {
|
|
continue;
|
|
}
|
|
|
|
const score = scoreEntry(q, entry);
|
|
if (score === 0) continue;
|
|
|
|
// Some hrefs intentionally appear in multiple catalog categories
|
|
// (e.g. /admin/templates lives under both 'settings' and 'admin').
|
|
// Keep the highest-scoring variant so the dropdown never renders
|
|
// two rows with the same `id` (href) - React would otherwise warn
|
|
// about duplicate keys.
|
|
const existing = byHref.get(entry.href);
|
|
if (!existing || score > existing.score) {
|
|
byHref.set(entry.href, { ...entry, score });
|
|
}
|
|
}
|
|
|
|
const out = Array.from(byHref.values());
|
|
out.sort((a, b) => b.score - a.score);
|
|
return out.slice(0, limit);
|
|
}
|
|
|
|
function scoreEntry(q: string, entry: NavCatalogEntry): number {
|
|
const label = entry.label.toLowerCase();
|
|
|
|
// Strongest signals first.
|
|
if (label === q) return 100;
|
|
if (label.startsWith(q)) return 80;
|
|
if (label.includes(q)) return 60;
|
|
|
|
// Keyword hits - strongest if the keyword exactly equals the query
|
|
// (e.g. user types "smtp"), then prefix, then substring.
|
|
for (const kw of entry.keywords) {
|
|
const k = kw.toLowerCase();
|
|
if (k === q) return 50;
|
|
if (k.startsWith(q)) return 35;
|
|
if (k.includes(q)) return 20;
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
|
|
function hasPermission(perms: RolePermissions | null, dotPath: string): boolean {
|
|
if (!perms) return false;
|
|
const parts = dotPath.split('.');
|
|
let cur: unknown = perms;
|
|
for (const part of parts) {
|
|
if (typeof cur !== 'object' || cur === null) return false;
|
|
cur = (cur as Record<string, unknown>)[part];
|
|
}
|
|
return cur === true;
|
|
}
|