feat(modules): venue-module registry — entitled ∩ activated, requireModule, Setup panel
Groundwork for the Car Wash pilot (wiki/decisions/venue-modules.md, build-order
steps 1 + 3). No Car Wash code yet; validation is the first module behind the
seam, unchanged in behaviour.
- @parking/shared: MODULE_IDS, ModuleManifest, MODULES (parking required;
validation dependsOn parking), parseEntitledModules / resolveModuleActivation
/ effectiveModules as pure functions.
- DB: site_config.modules_json (migration 0026, hand-written + journal;
additive, nullable = everything entitled).
- Server: modules.ts (entitledModules from MODULES_ENTITLED env, activated
from site_config, effective set, requireModule preHandler → 403
module_disabled); modules/index.ts registers folder-based modules by
iterating the registry (modules/validation); site-config GET exposes
modules/modulesEntitled/modulesActivated, PUT takes the full desired set,
enforces entitlement + dependency rules (400 with reason) and signs one
config_change per module that actually flips; /api/auth/me carries the
effective set; validation routes guarded requireModule → requirePermission.
- Web: lib/modules.ts + modules/{index,validation}; router.tsx spreads
WEB_MODULES into nav + route tree (validate route no longer named there);
Setup → Site "Modules" panel (required shown disabled, dependencies as
hints, server refusal shown verbatim); validation sections + programs fetch
gated on the module; App invalidates the router whenever the session
changes (route-context consumers only re-read on navigation — the nav was
stale after a flip, and after every other setUser too).
- Lavazh validation station retired (STATIONS = ["bar"]; rows untouched).
- Deploy: MODULES_ENTITLED=parking,validation explicit in both booth stacks;
documented in .env.example.
- Tests: modules.test.ts (7); suite 329/329; web build clean; Playwright
round-trip on /setup/site verified live.
Claude-Session: https://claude.ai/code/session_01FWncR69HgGPuei1dLrW3cU
This commit is contained in:
@@ -0,0 +1,9 @@
|
||||
import type { WebModule } from "../lib/modules.js";
|
||||
import { validationModule } from "./validation/index.js";
|
||||
|
||||
// The web-side module registry, in display order. Adding a module = its folder here
|
||||
// + one entry below (+ the manifest in @parking/shared). router.tsx spreads these
|
||||
// into the nav and the route tree and never names a module's screens itself.
|
||||
// `parking` has no folder yet — its screens are still declared directly in
|
||||
// router.tsx; they move behind this seam subsystem by subsystem.
|
||||
export const WEB_MODULES: readonly WebModule[] = [validationModule];
|
||||
@@ -0,0 +1,34 @@
|
||||
import { createRoute, redirect, useRouteContext } from "@tanstack/react-router";
|
||||
import { can } from "../../api.js";
|
||||
import { moduleOn, type RootRoute, type WebModule } from "../../lib/modules.js";
|
||||
import type { RouterContext } from "../../router.js";
|
||||
import { ValidateScreen } from "../../ValidateScreen.js";
|
||||
|
||||
// Merchant-scan ticket validation as a venue module (kept for the Bar —
|
||||
// wiki/decisions/venue-modules.md, decision 1). The merchant (bar) scan-and-validate
|
||||
// screen is usually the ONLY page a merchant user's role can reach. The server
|
||||
// enforces module-on + the program↔user binding on apply; the gates here are
|
||||
// defence in depth / display. See wiki/concepts/validation-discounts.md.
|
||||
|
||||
export const validationModule: WebModule = {
|
||||
id: "validation",
|
||||
nav: [{ to: "/validate", labelKey: "nav.validate", perm: "validation:create" }],
|
||||
routes(root: RootRoute) {
|
||||
const validateRoute = createRoute({
|
||||
getParentRoute: () => root,
|
||||
path: "/validate",
|
||||
beforeLoad: ({ context }) => {
|
||||
const ctx = context as RouterContext;
|
||||
if (!moduleOn(ctx.user, "validation") || !can(ctx.user, "validation:create")) {
|
||||
throw redirect({ to: "/booth" });
|
||||
}
|
||||
},
|
||||
component: function ValidateRoute() {
|
||||
const { user } = useRouteContext({ strict: false }) as RouterContext;
|
||||
if (!user) return null;
|
||||
return <ValidateScreen user={user} />;
|
||||
},
|
||||
});
|
||||
return [validateRoute];
|
||||
},
|
||||
};
|
||||
Reference in New Issue
Block a user