Merge branch 'master' into fix/crewing-exhand-admin-only
This commit is contained in:
commit
e7888a0886
11 changed files with 329 additions and 58 deletions
|
|
@ -62,6 +62,13 @@ FORGEJO_URL=https://git.pelagiamarine.com
|
||||||
FORGEJO_REPO=shad0w/pelagia-portal
|
FORGEJO_REPO=shad0w/pelagia-portal
|
||||||
FORGEJO_TOKEN=
|
FORGEJO_TOKEN=
|
||||||
|
|
||||||
|
# ── Feature flags (NEXT_PUBLIC_, available to client + server) ─
|
||||||
|
# Inventory tracking (site stock / consumption). On unless explicitly "false".
|
||||||
|
# NEXT_PUBLIC_INVENTORY_ENABLED=false
|
||||||
|
# Let submitters (TECHNICAL/MANNING) read & export every PO and open the History
|
||||||
|
# page (read-only). Opt-in — on only when exactly "true".
|
||||||
|
# NEXT_PUBLIC_SUBMITTER_VIEW_ALL_ENABLED=true
|
||||||
|
|
||||||
# ── Non-production banner ─────────────────────────────────────
|
# ── Non-production banner ─────────────────────────────────────
|
||||||
# When set, a fixed "internal dev / staging" banner is shown (EnvBanner).
|
# When set, a fixed "internal dev / staging" banner is shown (EnvBanner).
|
||||||
# Leave UNSET in production. Staging sets this automatically.
|
# Leave UNSET in production. Staging sets this automatically.
|
||||||
|
|
|
||||||
|
|
@ -232,6 +232,7 @@ FORGEJO_URL, FORGEJO_REPO, FORGEJO_TOKEN
|
||||||
GST_SERVICE_URL # GstService microservice (defaults to localhost:3003)
|
GST_SERVICE_URL # GstService microservice (defaults to localhost:3003)
|
||||||
EPFO_SERVICE_URL # EpfoService microservice for UAN lookup (defaults to localhost:3004)
|
EPFO_SERVICE_URL # EpfoService microservice for UAN lookup (defaults to localhost:3004)
|
||||||
NEXT_PUBLIC_INVENTORY_ENABLED # Inventory feature flag
|
NEXT_PUBLIC_INVENTORY_ENABLED # Inventory feature flag
|
||||||
|
NEXT_PUBLIC_SUBMITTER_VIEW_ALL_ENABLED # Opt-in ("true"): submitters (TECHNICAL/MANNING) read & export every PO + History (read-only)
|
||||||
NEXT_PUBLIC_CREWING_ENABLED # Crewing module feature flag (opt-in "true"; off by default)
|
NEXT_PUBLIC_CREWING_ENABLED # Crewing module feature flag (opt-in "true"; off by default)
|
||||||
NEXT_PUBLIC_ENV_LABEL # When set, shows a non-prod banner (EnvBanner). Leave unset in prod.
|
NEXT_PUBLIC_ENV_LABEL # When set, shows a non-prod banner (EnvBanner). Leave unset in prod.
|
||||||
```
|
```
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
import { auth } from "@/auth";
|
import { auth } from "@/auth";
|
||||||
import { db } from "@/lib/db";
|
import { db } from "@/lib/db";
|
||||||
import { hasPermission } from "@/lib/permissions";
|
import { hasPermission, submitterCanViewAll } from "@/lib/permissions";
|
||||||
import { redirect } from "next/navigation";
|
import { redirect } from "next/navigation";
|
||||||
import Link from "next/link";
|
import Link from "next/link";
|
||||||
import { formatCurrency, formatDate } from "@/lib/utils";
|
import { formatCurrency, formatDate } from "@/lib/utils";
|
||||||
|
|
@ -27,7 +27,14 @@ export default async function HistoryPage({ searchParams }: Props) {
|
||||||
const session = await auth();
|
const session = await auth();
|
||||||
if (!session?.user) redirect("/login");
|
if (!session?.user) redirect("/login");
|
||||||
|
|
||||||
if (!hasPermission(session.user.role, "export_reports")) redirect("/dashboard");
|
// Report-export holders see History; submitters get read+export access when the
|
||||||
|
// submitter-view-all feature flag is on.
|
||||||
|
if (
|
||||||
|
!hasPermission(session.user.role, "export_reports") &&
|
||||||
|
!submitterCanViewAll(session.user.role)
|
||||||
|
) {
|
||||||
|
redirect("/dashboard");
|
||||||
|
}
|
||||||
|
|
||||||
const { dateFrom, dateTo, approvedFrom, approvedTo, vesselId, status } = await searchParams;
|
const { dateFrom, dateTo, approvedFrom, approvedTo, vesselId, status } = await searchParams;
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,7 @@ import { auth } from "@/auth";
|
||||||
import { db } from "@/lib/db";
|
import { db } from "@/lib/db";
|
||||||
import { notFound, redirect } from "next/navigation";
|
import { notFound, redirect } from "next/navigation";
|
||||||
import { PoDetail } from "@/components/po/po-detail";
|
import { PoDetail } from "@/components/po/po-detail";
|
||||||
|
import { canViewAllPos } from "@/lib/permissions";
|
||||||
import { VendorIdForm } from "./vendor-id-form";
|
import { VendorIdForm } from "./vendor-id-form";
|
||||||
import type { Metadata } from "next";
|
import type { Metadata } from "next";
|
||||||
|
|
||||||
|
|
@ -39,11 +40,11 @@ export default async function PoDetailPage({ params }: Props) {
|
||||||
|
|
||||||
if (!po) notFound();
|
if (!po) notFound();
|
||||||
|
|
||||||
// Submitters can only view their own POs (unless they have view_all_pos)
|
// Submitters can only view their own POs — unless they hold view_all_pos, or the
|
||||||
const canViewAll = ["ACCOUNTS", "MANAGER", "SUPERUSER", "AUDITOR", "ADMIN"].includes(
|
// submitter-view-all feature flag grants them read access to every PO.
|
||||||
session.user.role
|
if (!canViewAllPos(session.user.role) && po.submitterId !== session.user.id) {
|
||||||
);
|
redirect("/dashboard");
|
||||||
if (!canViewAll && po.submitterId !== session.user.id) redirect("/dashboard");
|
}
|
||||||
|
|
||||||
const canProvideVendorId =
|
const canProvideVendorId =
|
||||||
po.status === "VENDOR_ID_PENDING" &&
|
po.status === "VENDOR_ID_PENDING" &&
|
||||||
|
|
|
||||||
|
|
@ -7,6 +7,7 @@ import { downloadBuffer } from "@/lib/storage";
|
||||||
import { CANCELLED_WATERMARK_PNG_BASE64, CANCELLED_WATERMARK_W, CANCELLED_WATERMARK_H } from "@/lib/cancelled-watermark";
|
import { CANCELLED_WATERMARK_PNG_BASE64, CANCELLED_WATERMARK_W, CANCELLED_WATERMARK_H } from "@/lib/cancelled-watermark";
|
||||||
import { getImageSize, scaleToBox } from "@/lib/image-size";
|
import { getImageSize, scaleToBox } from "@/lib/image-size";
|
||||||
import { signatoryLayout } from "@/lib/po-export-layout";
|
import { signatoryLayout } from "@/lib/po-export-layout";
|
||||||
|
import { canViewAllPos } from "@/lib/permissions";
|
||||||
|
|
||||||
// ── Company fallback constants (used when no company is linked to a PO) ──────
|
// ── Company fallback constants (used when no company is linked to a PO) ──────
|
||||||
|
|
||||||
|
|
@ -66,8 +67,9 @@ export async function GET(request: NextRequest, { params }: Props) {
|
||||||
});
|
});
|
||||||
if (!po) return NextResponse.json({ error: "Not found" }, { status: 404 });
|
if (!po) return NextResponse.json({ error: "Not found" }, { status: 404 });
|
||||||
|
|
||||||
const canViewAll = ["ACCOUNTS", "MANAGER", "SUPERUSER", "AUDITOR", "ADMIN"].includes(session.user.role);
|
// view_all_pos holders, or submitters when the view-all feature flag is on, may export
|
||||||
if (!canViewAll && po.submitterId !== session.user.id) {
|
// any PO; everyone else only their own.
|
||||||
|
if (!canViewAllPos(session.user.role) && po.submitterId !== session.user.id) {
|
||||||
return NextResponse.json({ error: "Forbidden" }, { status: 403 });
|
return NextResponse.json({ error: "Forbidden" }, { status: 403 });
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
import { auth } from "@/auth";
|
import { auth } from "@/auth";
|
||||||
import { db } from "@/lib/db";
|
import { db } from "@/lib/db";
|
||||||
import { hasPermission } from "@/lib/permissions";
|
import { hasPermission, submitterCanViewAll } from "@/lib/permissions";
|
||||||
import { NextRequest, NextResponse } from "next/server";
|
import { NextRequest, NextResponse } from "next/server";
|
||||||
import type { POStatus } from "@prisma/client";
|
import type { POStatus } from "@prisma/client";
|
||||||
|
|
||||||
|
|
@ -16,7 +16,10 @@ export async function GET(request: NextRequest) {
|
||||||
if (!session?.user) {
|
if (!session?.user) {
|
||||||
return NextResponse.json({ error: "Unauthorized" }, { status: 401 });
|
return NextResponse.json({ error: "Unauthorized" }, { status: 401 });
|
||||||
}
|
}
|
||||||
if (!hasPermission(session.user.role, "export_reports")) {
|
if (
|
||||||
|
!hasPermission(session.user.role, "export_reports") &&
|
||||||
|
!submitterCanViewAll(session.user.role)
|
||||||
|
) {
|
||||||
return NextResponse.json({ error: "Forbidden" }, { status: 403 });
|
return NextResponse.json({ error: "Forbidden" }, { status: 403 });
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,8 +1,9 @@
|
||||||
"use client";
|
"use client";
|
||||||
|
|
||||||
|
import { useEffect, useState } from "react";
|
||||||
import { usePathname } from "next/navigation";
|
import { usePathname } from "next/navigation";
|
||||||
import Link from "next/link";
|
import Link from "next/link";
|
||||||
import { INVENTORY_ENABLED, CREWING_ENABLED } from "@/lib/feature-flags";
|
import { INVENTORY_ENABLED, SUBMITTER_VIEW_ALL_ENABLED, CREWING_ENABLED } from "@/lib/feature-flags";
|
||||||
import { cn } from "@/lib/utils";
|
import { cn } from "@/lib/utils";
|
||||||
import {
|
import {
|
||||||
LayoutDashboard,
|
LayoutDashboard,
|
||||||
|
|
@ -33,6 +34,7 @@ import {
|
||||||
UserCog,
|
UserCog,
|
||||||
Gauge,
|
Gauge,
|
||||||
BadgeCheck,
|
BadgeCheck,
|
||||||
|
ChevronRight,
|
||||||
} from "lucide-react";
|
} from "lucide-react";
|
||||||
import type { Role } from "@prisma/client";
|
import type { Role } from "@prisma/client";
|
||||||
|
|
||||||
|
|
@ -43,6 +45,13 @@ interface NavItem {
|
||||||
roles?: Role[];
|
roles?: Role[];
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// History is open to all-PO viewers; when the submitter-view-all flag is on, submitters
|
||||||
|
// (TECHNICAL / MANNING) get read+export access to it too.
|
||||||
|
const HISTORY_ROLES: Role[] = [
|
||||||
|
"MANAGER", "SUPERUSER", "AUDITOR", "ADMIN",
|
||||||
|
...(SUBMITTER_VIEW_ALL_ENABLED ? (["TECHNICAL", "MANNING"] as Role[]) : []),
|
||||||
|
];
|
||||||
|
|
||||||
const NAV_ITEMS: NavItem[] = [
|
const NAV_ITEMS: NavItem[] = [
|
||||||
{ href: "/dashboard", label: "Dashboard", icon: LayoutDashboard },
|
{ href: "/dashboard", label: "Dashboard", icon: LayoutDashboard },
|
||||||
{ href: "/po/new", label: "New PO", icon: Plus, roles: ["TECHNICAL", "MANNING", "MANAGER", "SUPERUSER"] },
|
{ href: "/po/new", label: "New PO", icon: Plus, roles: ["TECHNICAL", "MANNING", "MANAGER", "SUPERUSER"] },
|
||||||
|
|
@ -51,7 +60,7 @@ const NAV_ITEMS: NavItem[] = [
|
||||||
{ href: "/approvals", label: "Approvals", icon: CheckSquare, roles: ["MANAGER", "SUPERUSER"] },
|
{ href: "/approvals", label: "Approvals", icon: CheckSquare, roles: ["MANAGER", "SUPERUSER"] },
|
||||||
{ href: "/payments", label: "Payments", icon: CreditCard, roles: ["ACCOUNTS"] },
|
{ href: "/payments", label: "Payments", icon: CreditCard, roles: ["ACCOUNTS"] },
|
||||||
{ href: "/payments/history", label: "Payment History", icon: Receipt, roles: ["ACCOUNTS", "SUPERUSER"] },
|
{ href: "/payments/history", label: "Payment History", icon: Receipt, roles: ["ACCOUNTS", "SUPERUSER"] },
|
||||||
{ href: "/history", label: "History", icon: History, roles: ["MANAGER", "SUPERUSER", "AUDITOR", "ADMIN"] },
|
{ href: "/history", label: "History", icon: History, roles: HISTORY_ROLES },
|
||||||
{ href: "/profile", label: "My Profile", icon: UserCircle },
|
{ href: "/profile", label: "My Profile", icon: UserCircle },
|
||||||
];
|
];
|
||||||
|
|
||||||
|
|
@ -117,6 +126,16 @@ const ADMIN_ITEMS: NavItem[] = [
|
||||||
{ href: "/admin/companies", label: "Companies", icon: Briefcase },
|
{ href: "/admin/companies", label: "Companies", icon: Briefcase },
|
||||||
];
|
];
|
||||||
|
|
||||||
|
interface Section {
|
||||||
|
id: string;
|
||||||
|
label: string;
|
||||||
|
items: NavItem[];
|
||||||
|
}
|
||||||
|
|
||||||
|
function isItemActive(href: string, pathname: string) {
|
||||||
|
return pathname === href || pathname.startsWith(href + "/");
|
||||||
|
}
|
||||||
|
|
||||||
export function Sidebar({ userRole }: { userRole: Role }) {
|
export function Sidebar({ userRole }: { userRole: Role }) {
|
||||||
const pathname = usePathname();
|
const pathname = usePathname();
|
||||||
const isAdmin = userRole === "ADMIN";
|
const isAdmin = userRole === "ADMIN";
|
||||||
|
|
@ -125,6 +144,31 @@ export function Sidebar({ userRole }: { userRole: Role }) {
|
||||||
const visiblePurchasing = PURCHASING_ITEMS.filter((i) => !i.roles || i.roles.includes(userRole));
|
const visiblePurchasing = PURCHASING_ITEMS.filter((i) => !i.roles || i.roles.includes(userRole));
|
||||||
const visibleCrewing = CREWING_ITEMS.filter((i) => !i.roles || i.roles.includes(userRole));
|
const visibleCrewing = CREWING_ITEMS.filter((i) => !i.roles || i.roles.includes(userRole));
|
||||||
const visibleMgrAdmin = MANAGER_ADMIN_ITEMS.filter((i) => !i.roles || i.roles.includes(userRole));
|
const visibleMgrAdmin = MANAGER_ADMIN_ITEMS.filter((i) => !i.roles || i.roles.includes(userRole));
|
||||||
|
const adminItems = isAdmin ? [...MANAGER_ADMIN_ITEMS, ...ADMIN_ITEMS] : visibleMgrAdmin;
|
||||||
|
|
||||||
|
// Headed, collapsible sections (the main links above sit outside any section).
|
||||||
|
const sections: Section[] = [
|
||||||
|
{ id: "purchasing", label: "Purchasing", items: visiblePurchasing },
|
||||||
|
{ id: "crewing", label: "Crewing", items: visibleCrewing },
|
||||||
|
{ id: "administration", label: "Administration", items: adminItems },
|
||||||
|
].filter((s) => s.items.length > 0);
|
||||||
|
|
||||||
|
// The section (if any) that holds the currently active route.
|
||||||
|
const activeSectionId =
|
||||||
|
sections.find((s) => s.items.some((i) => isItemActive(i.href, pathname)))?.id ?? null;
|
||||||
|
|
||||||
|
// Single-open accordion, collapsed by default. Auto-expand the section that
|
||||||
|
// contains the active route so the user is never stranded on a hidden link.
|
||||||
|
const [openSection, setOpenSection] = useState<string | null>(activeSectionId);
|
||||||
|
|
||||||
|
// On navigation, open the section holding the new active route (which, being a
|
||||||
|
// single-open accordion, collapses any other open heading).
|
||||||
|
useEffect(() => {
|
||||||
|
if (activeSectionId) setOpenSection(activeSectionId);
|
||||||
|
}, [activeSectionId]);
|
||||||
|
|
||||||
|
const toggleSection = (id: string) =>
|
||||||
|
setOpenSection((current) => (current === id ? null : id));
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<aside className="flex h-screen w-60 shrink-0 flex-col border-r border-neutral-200 bg-white">
|
<aside className="flex h-screen w-60 shrink-0 flex-col border-r border-neutral-200 bg-white">
|
||||||
|
|
@ -140,59 +184,61 @@ export function Sidebar({ userRole }: { userRole: Role }) {
|
||||||
<NavLink key={item.href} item={item} pathname={pathname} />
|
<NavLink key={item.href} item={item} pathname={pathname} />
|
||||||
))}
|
))}
|
||||||
|
|
||||||
{visiblePurchasing.length > 0 && (
|
{sections.map((section) => {
|
||||||
<>
|
const isOpen = openSection === section.id;
|
||||||
<SectionHeader label="Purchasing" />
|
const regionId = `nav-section-${section.id}`;
|
||||||
{visiblePurchasing.map((item) => (
|
return (
|
||||||
<NavLink key={item.href} item={item} pathname={pathname} />
|
<div key={section.id}>
|
||||||
))}
|
<SectionHeader
|
||||||
</>
|
label={section.label}
|
||||||
)}
|
isOpen={isOpen}
|
||||||
|
regionId={regionId}
|
||||||
{/* Crewing — only renders once the flag is on and items exist (later phases) */}
|
onToggle={() => toggleSection(section.id)}
|
||||||
{visibleCrewing.length > 0 && (
|
/>
|
||||||
<>
|
{isOpen && (
|
||||||
<SectionHeader label="Crewing" />
|
<div id={regionId} className="space-y-0.5">
|
||||||
{visibleCrewing.map((item) => (
|
{section.items.map((item) => (
|
||||||
<NavLink key={item.href} item={item} pathname={pathname} />
|
<NavLink key={item.href} item={item} pathname={pathname} />
|
||||||
))}
|
))}
|
||||||
</>
|
</div>
|
||||||
)}
|
)}
|
||||||
|
</div>
|
||||||
{/* Vendors under Administration for MANAGER / ACCOUNTS */}
|
);
|
||||||
{!isAdmin && visibleMgrAdmin.length > 0 && (
|
})}
|
||||||
<>
|
|
||||||
<SectionHeader label="Administration" />
|
|
||||||
{visibleMgrAdmin.map((item) => (
|
|
||||||
<NavLink key={item.href} item={item} pathname={pathname} />
|
|
||||||
))}
|
|
||||||
</>
|
|
||||||
)}
|
|
||||||
|
|
||||||
{/* Full Administration section for ADMIN */}
|
|
||||||
{isAdmin && (
|
|
||||||
<>
|
|
||||||
<SectionHeader label="Administration" />
|
|
||||||
{[...MANAGER_ADMIN_ITEMS, ...ADMIN_ITEMS].map((item) => (
|
|
||||||
<NavLink key={item.href} item={item} pathname={pathname} />
|
|
||||||
))}
|
|
||||||
</>
|
|
||||||
)}
|
|
||||||
</nav>
|
</nav>
|
||||||
</aside>
|
</aside>
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
function SectionHeader({ label }: { label: string }) {
|
function SectionHeader({
|
||||||
|
label,
|
||||||
|
isOpen,
|
||||||
|
regionId,
|
||||||
|
onToggle,
|
||||||
|
}: {
|
||||||
|
label: string;
|
||||||
|
isOpen: boolean;
|
||||||
|
regionId: string;
|
||||||
|
onToggle: () => void;
|
||||||
|
}) {
|
||||||
return (
|
return (
|
||||||
<div className="pt-4 pb-1 px-3">
|
<button
|
||||||
<p className="text-xs font-semibold text-neutral-400 uppercase tracking-wider">{label}</p>
|
type="button"
|
||||||
</div>
|
onClick={onToggle}
|
||||||
|
aria-expanded={isOpen}
|
||||||
|
aria-controls={regionId}
|
||||||
|
className="flex w-full items-center justify-between pt-4 pb-1 px-3 text-xs font-semibold text-neutral-400 uppercase tracking-wider hover:text-neutral-600"
|
||||||
|
>
|
||||||
|
<span>{label}</span>
|
||||||
|
<ChevronRight
|
||||||
|
className={cn("h-3.5 w-3.5 shrink-0 transition-transform", isOpen && "rotate-90")}
|
||||||
|
/>
|
||||||
|
</button>
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
function NavLink({ item, pathname }: { item: NavItem; pathname: string }) {
|
function NavLink({ item, pathname }: { item: NavItem; pathname: string }) {
|
||||||
const isActive = pathname === item.href || pathname.startsWith(item.href + "/");
|
const isActive = isItemActive(item.href, pathname);
|
||||||
const Icon = item.icon;
|
const Icon = item.icon;
|
||||||
return (
|
return (
|
||||||
<Link
|
<Link
|
||||||
|
|
|
||||||
|
|
@ -5,6 +5,12 @@
|
||||||
* NEXT_PUBLIC_INVENTORY_ENABLED=false → hides inventory tracking (site qty/consumption)
|
* NEXT_PUBLIC_INVENTORY_ENABLED=false → hides inventory tracking (site qty/consumption)
|
||||||
* Vendor list, product catalogue, and cart remain available for PO creation regardless.
|
* Vendor list, product catalogue, and cart remain available for PO creation regardless.
|
||||||
*
|
*
|
||||||
|
* NEXT_PUBLIC_SUBMITTER_VIEW_ALL_ENABLED=true → lets submitters (TECHNICAL / MANNING)
|
||||||
|
* read every PO (not just their own), open the History page, and use the export buttons.
|
||||||
|
* Opt-in (off unless explicitly "true") because it widens read access. Submitters stay
|
||||||
|
* read-only — it grants no approval, payment, or edit rights. See lib/permissions.ts
|
||||||
|
* (canViewAllPos / submitterCanViewAll).
|
||||||
|
*
|
||||||
* NEXT_PUBLIC_CREWING_ENABLED=true → exposes the Crewing module (crew/ranks/requisitions
|
* NEXT_PUBLIC_CREWING_ENABLED=true → exposes the Crewing module (crew/ranks/requisitions
|
||||||
* etc.). Opt-in (off unless explicitly "true") because the feature is built incrementally;
|
* etc.). Opt-in (off unless explicitly "true") because the feature is built incrementally;
|
||||||
* keeping it dark by default leaves production unchanged. See lib/permissions.ts (§6 matrix)
|
* keeping it dark by default leaves production unchanged. See lib/permissions.ts (§6 matrix)
|
||||||
|
|
@ -14,5 +20,8 @@
|
||||||
export const INVENTORY_ENABLED =
|
export const INVENTORY_ENABLED =
|
||||||
process.env.NEXT_PUBLIC_INVENTORY_ENABLED !== "false";
|
process.env.NEXT_PUBLIC_INVENTORY_ENABLED !== "false";
|
||||||
|
|
||||||
|
export const SUBMITTER_VIEW_ALL_ENABLED =
|
||||||
|
process.env.NEXT_PUBLIC_SUBMITTER_VIEW_ALL_ENABLED === "true";
|
||||||
|
|
||||||
export const CREWING_ENABLED =
|
export const CREWING_ENABLED =
|
||||||
process.env.NEXT_PUBLIC_CREWING_ENABLED === "true";
|
process.env.NEXT_PUBLIC_CREWING_ENABLED === "true";
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,5 @@
|
||||||
import type { Role } from "@prisma/client";
|
import type { Role } from "@prisma/client";
|
||||||
|
import { SUBMITTER_VIEW_ALL_ENABLED } from "./feature-flags";
|
||||||
|
|
||||||
export type Permission =
|
export type Permission =
|
||||||
| "create_po"
|
| "create_po"
|
||||||
|
|
@ -237,3 +238,31 @@ export function requirePermission(role: Role, permission: Permission): void {
|
||||||
export function getPermissions(role: Role): Permission[] {
|
export function getPermissions(role: Role): Permission[] {
|
||||||
return ROLE_PERMISSIONS[role] ?? [];
|
return ROLE_PERMISSIONS[role] ?? [];
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// ── Submitter roles & feature-flagged view-all ────────────────────────────────
|
||||||
|
// Submitters raise and track their own POs. The two "submitter" roles below hold
|
||||||
|
// `view_own_pos` but not `view_all_pos`.
|
||||||
|
|
||||||
|
export const SUBMITTER_ROLES: Role[] = ["TECHNICAL", "MANNING"];
|
||||||
|
|
||||||
|
export function isSubmitterRole(role: Role): boolean {
|
||||||
|
return SUBMITTER_ROLES.includes(role);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Feature-flagged: when NEXT_PUBLIC_SUBMITTER_VIEW_ALL_ENABLED=true, submitters may
|
||||||
|
* read & export every PO (not just their own) and reach the History page. This is a
|
||||||
|
* read-only widening — it does not grant approval, payment, or edit rights.
|
||||||
|
*/
|
||||||
|
export function submitterCanViewAll(role: Role): boolean {
|
||||||
|
return SUBMITTER_VIEW_ALL_ENABLED && isSubmitterRole(role);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Whether a role may view/export any PO, not just the ones they submitted.
|
||||||
|
* True for `view_all_pos` holders (ACCOUNTS, MANAGER, SUPERUSER, AUDITOR, ADMIN) and,
|
||||||
|
* when the feature flag is on, for submitters too.
|
||||||
|
*/
|
||||||
|
export function canViewAllPos(role: Role): boolean {
|
||||||
|
return hasPermission(role, "view_all_pos") || submitterCanViewAll(role);
|
||||||
|
}
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,11 @@
|
||||||
import { describe, it, expect } from "vitest";
|
import { describe, it, expect, vi, afterEach } from "vitest";
|
||||||
import { hasPermission, requirePermission } from "@/lib/permissions";
|
import {
|
||||||
|
hasPermission,
|
||||||
|
requirePermission,
|
||||||
|
isSubmitterRole,
|
||||||
|
submitterCanViewAll,
|
||||||
|
canViewAllPos,
|
||||||
|
} from "@/lib/permissions";
|
||||||
|
|
||||||
describe("Permissions", () => {
|
describe("Permissions", () => {
|
||||||
describe("hasPermission", () => {
|
describe("hasPermission", () => {
|
||||||
|
|
@ -99,6 +105,64 @@ describe("Permissions", () => {
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
// ── Submitter view-all (feature-flagged) ──────────────────────────────────
|
||||||
|
describe("isSubmitterRole", () => {
|
||||||
|
it("is true for the two submitter roles", () => {
|
||||||
|
expect(isSubmitterRole("TECHNICAL")).toBe(true);
|
||||||
|
expect(isSubmitterRole("MANNING")).toBe(true);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("is false for every other role", () => {
|
||||||
|
for (const role of ["ACCOUNTS", "MANAGER", "SUPERUSER", "AUDITOR", "ADMIN"] as const) {
|
||||||
|
expect(isSubmitterRole(role)).toBe(false);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("canViewAllPos / submitterCanViewAll — flag OFF (default)", () => {
|
||||||
|
it("submitters cannot view all POs", () => {
|
||||||
|
expect(canViewAllPos("TECHNICAL")).toBe(false);
|
||||||
|
expect(canViewAllPos("MANNING")).toBe(false);
|
||||||
|
expect(submitterCanViewAll("TECHNICAL")).toBe(false);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("view_all_pos holders can still view all POs", () => {
|
||||||
|
for (const role of ["ACCOUNTS", "MANAGER", "SUPERUSER", "AUDITOR", "ADMIN"] as const) {
|
||||||
|
expect(canViewAllPos(role)).toBe(true);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("canViewAllPos / submitterCanViewAll — flag ON", () => {
|
||||||
|
afterEach(() => {
|
||||||
|
vi.unstubAllEnvs();
|
||||||
|
vi.resetModules();
|
||||||
|
});
|
||||||
|
|
||||||
|
it("submitters gain view-all when NEXT_PUBLIC_SUBMITTER_VIEW_ALL_ENABLED=true", async () => {
|
||||||
|
vi.resetModules();
|
||||||
|
vi.stubEnv("NEXT_PUBLIC_SUBMITTER_VIEW_ALL_ENABLED", "true");
|
||||||
|
const perms = await import("@/lib/permissions");
|
||||||
|
|
||||||
|
expect(perms.submitterCanViewAll("TECHNICAL")).toBe(true);
|
||||||
|
expect(perms.submitterCanViewAll("MANNING")).toBe(true);
|
||||||
|
expect(perms.canViewAllPos("TECHNICAL")).toBe(true);
|
||||||
|
expect(perms.canViewAllPos("MANNING")).toBe(true);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("does not widen non-submitter roles, and is read-only (no approve/edit)", async () => {
|
||||||
|
vi.resetModules();
|
||||||
|
vi.stubEnv("NEXT_PUBLIC_SUBMITTER_VIEW_ALL_ENABLED", "true");
|
||||||
|
const perms = await import("@/lib/permissions");
|
||||||
|
|
||||||
|
expect(perms.submitterCanViewAll("MANAGER")).toBe(false);
|
||||||
|
expect(perms.canViewAllPos("ACCOUNTS")).toBe(true); // unchanged
|
||||||
|
// The flag grants read access only — no approval or edit rights.
|
||||||
|
expect(perms.hasPermission("TECHNICAL", "approve_po")).toBe(false);
|
||||||
|
expect(perms.hasPermission("TECHNICAL", "view_all_pos")).toBe(false);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
describe("requirePermission", () => {
|
describe("requirePermission", () => {
|
||||||
it("does not throw when permission is granted", () => {
|
it("does not throw when permission is granted", () => {
|
||||||
expect(() => requirePermission("MANAGER", "approve_po")).not.toThrow();
|
expect(() => requirePermission("MANAGER", "approve_po")).not.toThrow();
|
||||||
|
|
|
||||||
102
App/tests/unit/sidebar.test.tsx
Normal file
102
App/tests/unit/sidebar.test.tsx
Normal file
|
|
@ -0,0 +1,102 @@
|
||||||
|
import { describe, it, expect, vi, beforeEach } from "vitest";
|
||||||
|
import { render, screen, fireEvent, within } from "@testing-library/react";
|
||||||
|
|
||||||
|
// usePathname is mockable per-test so we can exercise the auto-expand behaviour.
|
||||||
|
let mockPathname = "/dashboard";
|
||||||
|
vi.mock("next/navigation", () => ({ usePathname: () => mockPathname }));
|
||||||
|
|
||||||
|
import { Sidebar } from "@/components/layout/sidebar";
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
mockPathname = "/dashboard";
|
||||||
|
});
|
||||||
|
|
||||||
|
function headerButton(label: string) {
|
||||||
|
return screen.getByRole("button", { name: new RegExp(`^${label}`, "i") });
|
||||||
|
}
|
||||||
|
|
||||||
|
describe("Sidebar collapsible sections", () => {
|
||||||
|
it("renders section headings as toggle buttons, collapsed by default", () => {
|
||||||
|
// ADMIN sees a Purchasing-less layout? No — render a MANAGER who has
|
||||||
|
// Purchasing + Administration headed sections.
|
||||||
|
render(<Sidebar userRole="MANAGER" />);
|
||||||
|
|
||||||
|
const purchasing = headerButton("Purchasing");
|
||||||
|
const administration = headerButton("Administration");
|
||||||
|
|
||||||
|
expect(purchasing).toHaveAttribute("aria-expanded", "false");
|
||||||
|
expect(administration).toHaveAttribute("aria-expanded", "false");
|
||||||
|
|
||||||
|
// Collapsed → section links are not in the DOM.
|
||||||
|
expect(screen.queryByRole("link", { name: /Cost Centres/i })).not.toBeInTheDocument();
|
||||||
|
});
|
||||||
|
|
||||||
|
it("expands a section and reveals its links when its header is clicked", () => {
|
||||||
|
render(<Sidebar userRole="MANAGER" />);
|
||||||
|
|
||||||
|
const purchasing = headerButton("Purchasing");
|
||||||
|
fireEvent.click(purchasing);
|
||||||
|
|
||||||
|
expect(purchasing).toHaveAttribute("aria-expanded", "true");
|
||||||
|
expect(screen.getByRole("link", { name: /Cost Centres/i })).toBeInTheDocument();
|
||||||
|
});
|
||||||
|
|
||||||
|
it("collapses other sections when one is opened (single-open accordion)", () => {
|
||||||
|
render(<Sidebar userRole="MANAGER" />);
|
||||||
|
|
||||||
|
const purchasing = headerButton("Purchasing");
|
||||||
|
const administration = headerButton("Administration");
|
||||||
|
|
||||||
|
fireEvent.click(purchasing);
|
||||||
|
expect(purchasing).toHaveAttribute("aria-expanded", "true");
|
||||||
|
|
||||||
|
fireEvent.click(administration);
|
||||||
|
expect(administration).toHaveAttribute("aria-expanded", "true");
|
||||||
|
// Opening Administration collapses Purchasing.
|
||||||
|
expect(purchasing).toHaveAttribute("aria-expanded", "false");
|
||||||
|
});
|
||||||
|
|
||||||
|
it("toggles a section closed when its header is clicked again", () => {
|
||||||
|
render(<Sidebar userRole="MANAGER" />);
|
||||||
|
|
||||||
|
const purchasing = headerButton("Purchasing");
|
||||||
|
fireEvent.click(purchasing);
|
||||||
|
expect(purchasing).toHaveAttribute("aria-expanded", "true");
|
||||||
|
|
||||||
|
fireEvent.click(purchasing);
|
||||||
|
expect(purchasing).toHaveAttribute("aria-expanded", "false");
|
||||||
|
});
|
||||||
|
|
||||||
|
it("auto-expands the section containing the active route on mount", () => {
|
||||||
|
mockPathname = "/admin/vessels"; // Cost Centres lives under Administration (manager mgmt → Purchasing)
|
||||||
|
render(<Sidebar userRole="MANAGER" />);
|
||||||
|
|
||||||
|
// /admin/vessels is in the Purchasing management block for a MANAGER.
|
||||||
|
const purchasing = headerButton("Purchasing");
|
||||||
|
expect(purchasing).toHaveAttribute("aria-expanded", "true");
|
||||||
|
expect(screen.getByRole("link", { name: /Cost Centres/i })).toBeInTheDocument();
|
||||||
|
});
|
||||||
|
|
||||||
|
it("keeps the PPMS brand outside any collapsible section", () => {
|
||||||
|
render(<Sidebar userRole="MANAGER" />);
|
||||||
|
// Brand text is always visible regardless of section state.
|
||||||
|
expect(screen.getByText("PPMS")).toBeInTheDocument();
|
||||||
|
});
|
||||||
|
|
||||||
|
it("renders the always-visible main links outside the sections", () => {
|
||||||
|
render(<Sidebar userRole="MANAGER" />);
|
||||||
|
expect(screen.getByRole("link", { name: /Dashboard/i })).toBeInTheDocument();
|
||||||
|
expect(screen.getByRole("link", { name: /My Profile/i })).toBeInTheDocument();
|
||||||
|
});
|
||||||
|
|
||||||
|
it("scopes revealed links to the opened section", () => {
|
||||||
|
render(<Sidebar userRole="MANAGER" />);
|
||||||
|
const administration = headerButton("Administration");
|
||||||
|
fireEvent.click(administration);
|
||||||
|
|
||||||
|
// Vendors appears under Administration for a manager.
|
||||||
|
const adminVendors = screen.getByRole("link", { name: /Vendors/i });
|
||||||
|
expect(adminVendors).toBeInTheDocument();
|
||||||
|
expect(within(adminVendors).queryByText("Vendors")).toBeTruthy();
|
||||||
|
});
|
||||||
|
});
|
||||||
Loading…
Add table
Reference in a new issue