@t3b/hub-guard 0.7.0 → 0.8.0

package/README.md

@@ -253,6 +253,22 @@ export async function POST(req: Request) {
    - `mine:true, ok:false` puts the order aside: say why in the words the manager needs (`reason`, `reason_ar`).
    - Answer 200 for every case once the pass is good; the Hub waits 5 seconds and treats anything else as no answer.
 
+## Apps button: move between apps (0.8.0, WORKFLOWS §18)
+
+The Hub's pass and its 15-minute check carry the apps this person may open. Show them in ONE button, **Apps
+(التطبيقات)**, in the same place in your top bar, in place of a "Back to the Hub" link:
+
+```ts
+const lines = guard.appMenu(session);
+// [{ id: "hub", nameEn: "The Hub", nameAr: "الـHub", href: "https://t3b-hub.com/home", current: false },
+//  { id: "delivery", nameEn: "Delivery", nameAr: "التوصيل", href: "https://t3b-hub.com/go/delivery", current: true }, ...]
+```
+
+- Each line is a plain link (`href`); the Hub mints the next app's pass and goes straight on. Mark the `current` line,
+  never link it to itself.
+- A session opened before 0.8.0 (or by an older Hub) has no list: the button then holds the Hub line only.
+- `appMenu(session, { hubUrl, moduleId })` is the same without a Guard; `readApps(raw)` reads a list defensively.
+
 ## What it enforces
 
 - `/hub/enter?ticket=…`: an EdDSA ticket signed by the Hub's published key, for this module, from this environment's Hub, 60 seconds, single use → sets the module session (HttpOnly, Secure, SameSite=Strict) and answers a short "Opening …" page that moves on to the page (0.4.0: a SameSite=Strict cookie set on a redirect ending a navigation from another site is not sent on it). `appName` names the app on that page; `landing(path)` maps the pass's page (e.g. `"/"` → `"/app"`), never off the module's own address.
@@ -263,6 +279,9 @@ export async function POST(req: Request) {
 
 ## Changes
 
+- **0.8.0** (WORKFLOWS §18): the Apps button - the pass's and the 15-minute check's `apps` are kept in the session
+  (`session.apps`), `guard.appMenu(session)` / `appMenu()` give the lines, `readApps` reads a list defensively. Nothing
+  else changes; a module on 0.7.0 keeps working (its sessions simply carry no list).
 - **0.7.0** (WORKFLOWS §17): the packing station - `verifyStationCall` checks the Hub's pass for `station` (naming the
   station; on a pack, bound to the exact body), `stationRefusal`, `stationJson` and the answer types; `healthResponse(...,
   { station })` names the door so the Hub reads the manifest again by itself. Nothing else changes; a module on 0.6.0 keeps

package/dist/apps.d.ts

@@ -0,0 +1,28 @@
+/** One app the person may open, as the Hub sends it. */
+export type HubApp = {
+    id: string;
+    nameEn: string;
+    nameAr: string;
+};
+/** One line of the Apps button. `current`: this is the app the person is in. */
+export type AppMenuItem = {
+    id: string;
+    nameEn: string;
+    nameAr: string;
+    href: string;
+    current: boolean;
+};
+export declare const APP_ID_RE: RegExp;
+/** A pass's or check's `apps`, read defensively: anything malformed is dropped, never widened. */
+export declare function readApps(raw: unknown): HubApp[];
+/**
+ * The Apps button's lines for this person, in order: the Hub first (its Home), then every app they may open; the app
+ * they are in is marked `current`. A session from a Hub before 0.8.0 carries no list - the button then holds the Hub
+ * only, which is the way back as before.
+ */
+export declare function appMenu(session: {
+    apps?: HubApp[];
+}, cfg: {
+    hubUrl: string;
+    moduleId: string;
+}): AppMenuItem[];

package/dist/apps.js

@@ -0,0 +1,37 @@
+// WORKFLOWS §18 (0.8.0, D-069): the Apps button. The Hub's pass and its 15-minute check carry the apps this person may
+// open (the same list as the Hub's sidebar); every app shows them in one button in its top bar, with the Hub first and
+// the current app marked. A pick goes to `<hub>/go/<app>`, where the Hub mints that app's pass and goes straight on.
+export const APP_ID_RE = /^[a-z][a-z0-9-]{1,30}$/;
+const MAX_APPS = 30;
+const MAX_NAME = 60;
+/** A pass's or check's `apps`, read defensively: anything malformed is dropped, never widened. */
+export function readApps(raw) {
+    if (!Array.isArray(raw))
+        return [];
+    const out = [];
+    const seen = new Set();
+    for (const a of raw.slice(0, MAX_APPS)) {
+        if (!a || typeof a !== "object")
+            continue;
+        const { id, nameEn, nameAr } = a;
+        if (typeof id !== "string" || !APP_ID_RE.test(id) || seen.has(id))
+            continue;
+        const en = typeof nameEn === "string" && nameEn.trim() ? nameEn.trim().slice(0, MAX_NAME) : id;
+        const ar = typeof nameAr === "string" && nameAr.trim() ? nameAr.trim().slice(0, MAX_NAME) : en;
+        seen.add(id);
+        out.push({ id, nameEn: en, nameAr: ar });
+    }
+    return out;
+}
+/**
+ * The Apps button's lines for this person, in order: the Hub first (its Home), then every app they may open; the app
+ * they are in is marked `current`. A session from a Hub before 0.8.0 carries no list - the button then holds the Hub
+ * only, which is the way back as before.
+ */
+export function appMenu(session, cfg) {
+    const hub = cfg.hubUrl.replace(/\/$/, "");
+    return [
+        { id: "hub", nameEn: "The Hub", nameAr: "الـHub", href: `${hub}/home`, current: false },
+        ...(session.apps ?? []).map((a) => ({ id: a.id, nameEn: a.nameEn, nameAr: a.nameAr, href: `${hub}/go/${a.id}`, current: a.id === cfg.moduleId })),
+    ];
+}

package/dist/guard.d.ts

@@ -1,4 +1,5 @@
 import type { JWTVerifyGetKey } from "jose";
+import { type AppMenuItem } from "./apps.js";
 import { type TokenProvider } from "./identity.js";
 import { type ModuleSession } from "./session.js";
 export type GuardConfig = {
@@ -66,6 +67,8 @@ export declare class Guard {
     allows(session: ModuleSession, pageKey: string, need: "read" | "write"): boolean;
     /** §14: "You don't have access to this page" - 403; the session stays (other pages still open). */
     refusePage(req: Request, what?: string): Response;
+    /** §18 (0.8.0): the Apps button's lines for this session - the Hub first, then every app this person may open. */
+    appMenu(session: ModuleSession): AppMenuItem[];
     /** Signs out of the module only (the Hub session is untouched). */
     signOut(): Response;
 }

package/dist/guard.js

@@ -1,3 +1,4 @@
+import { appMenu } from "./apps.js";
 import { checkCloudflareAccess } from "./cf-access.js";
 import { sessionCheckPages } from "./hub-client.js";
 import { pageAllowed } from "./pages.js";
@@ -59,7 +60,7 @@ export class Guard {
             return this.refuse(req, words[v.reason] ?? "No valid ticket.");
         }
         const now = this.now().getTime();
-        const session = { personId: v.claims.sub, name: v.claims.name, role: v.claims.role, stores: v.claims.stores, sv: v.claims.sv, iat: now, lastSeen: now, checkedAt: now, pages: v.claims.pages };
+        const session = { personId: v.claims.sub, name: v.claims.name, role: v.claims.role, stores: v.claims.stores, sv: v.claims.sv, iat: now, lastSeen: now, checkedAt: now, pages: v.claims.pages, apps: v.claims.apps };
         const landed = new URL(this.cfg.landing ? this.cfg.landing(v.claims.path) : v.claims.path, url.origin);
         // never off this module's own address, whatever `landing` returns
         const target = landed.origin === url.origin ? landed : new URL("/", url.origin);
@@ -96,9 +97,9 @@ export class Guard {
             const r2 = await sessionCheckPages(this.hubClient(), s.personId, s.sv);
             if (r2.verdict === "refused")
                 return { allow: false, response: this.refuse(req, "The Hub ended this session (signed out everywhere, or access changed).") };
-            // §14: a change of ticks reaches the module here, within 15 minutes
+            // §14: a change of ticks reaches the module here, within 15 minutes - §18: and so does the Apps button's list
             if (r2.verdict === "ok")
-                s = { ...s, checkedAt: nowMs, ...(r2.pages ? { pages: r2.pages } : {}) };
+                s = { ...s, checkedAt: nowMs, ...(r2.pages ? { pages: r2.pages } : {}), ...(r2.apps ? { apps: r2.apps } : {}) };
         }
         s = { ...s, lastSeen: nowMs };
         return { allow: true, session: s, setCookie: cookieHeader(await signSession(s, secret), { secure: url.protocol === "https:", maxAgeS: Math.floor((this.cfg.absoluteMs ?? 8 * 3_600_000) / 1000) }) };
@@ -120,6 +121,10 @@ export class Guard {
         const html = `<!doctype html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1"><title>No access</title><style>body{margin:0;font-family:system-ui,-apple-system,sans-serif;background:#F6F5F3;color:#231F20;display:flex;align-items:center;justify-content:center;min-height:100vh}.card{background:#fff;border:1px solid #E7E5E2;border-radius:12px;padding:40px;max-width:440px;text-align:center}h1{font-size:22px;margin:0 0 12px}p{color:#6B6866;line-height:1.5;margin:0 0 24px}a{display:inline-block;background:#231F20;color:#fff;text-decoration:none;padding:14px 26px;border-radius:12px;font-size:13px;letter-spacing:.08em;text-transform:uppercase;font-weight:600}</style></head><body><div class="card"><h1>You don't have access to ${escapeHtml(what)}</h1><p>The owner gives access in the Hub: Settings → Staff.</p><a href="${escapeAttr(home)}">Go to the Hub</a></div></body></html>`;
         return new Response(html, { status: 403, headers: { "Content-Type": "text/html; charset=utf-8", "Cache-Control": "no-store" } });
     }
+    /** §18 (0.8.0): the Apps button's lines for this session - the Hub first, then every app this person may open. */
+    appMenu(session) {
+        return appMenu(session, { hubUrl: this.cfg.hubUrl, moduleId: this.cfg.moduleId });
+    }
     /** Signs out of the module only (the Hub session is untouched). */
     signOut() {
         return new Response(null, { status: 303, headers: { Location: this.cfg.hubHomeUrl ?? this.cfg.hubUrl, "Set-Cookie": clearCookieHeader() } });

package/dist/hub-client.d.ts

@@ -1,4 +1,5 @@
 import { type JWTVerifyGetKey } from "jose";
+import { type HubApp } from "./apps.js";
 import { type PageDef, type Pages } from "./pages.js";
 import { type TokenProvider } from "./identity.js";
 export type HubClientConfig = {
@@ -10,10 +11,14 @@ export type HubClientConfig = {
 };
 /** 2.4: does this person's Hub session still stand? `unknown` when the Hub did not answer (the module keeps the session until the next check). */
 export declare function sessionCheck(cfg: HubClientConfig, personId: string, sessionVersion: number): Promise<"ok" | "refused" | "unknown">;
-/** §14 (0.4.0): the same check, with the person's pages as the Hub holds them now (absent from a Hub before §14). */
+/**
+ * §14 (0.4.0): the same check, with the person's pages as the Hub holds them now (absent from a Hub before §14);
+ * §18 (0.8.0): and the apps they may open (absent from a Hub before §18).
+ */
 export declare function sessionCheckPages(cfg: HubClientConfig, personId: string, sessionVersion: number): Promise<{
     verdict: "ok" | "refused" | "unknown";
     pages?: Pages;
+    apps?: HubApp[];
 }>;
 export type BrokerToken = {
     accessToken: string;

package/dist/hub-client.js

@@ -1,4 +1,5 @@
 import { jwtVerify } from "jose";
+import { readApps } from "./apps.js";
 import { pagesFingerprint, readPages } from "./pages.js";
 import { APP_ID_HEADER, HUB_ISSUER, ownVercelToken, TYP, tokenFrom } from "./identity.js";
 const NO_ID = "This app has no Vercel ID to show the Hub - Vercel → the project → Settings → Security → Secure backend access (OIDC) must be on.";
@@ -35,14 +36,21 @@ async function post(cfg, path, body) {
 export async function sessionCheck(cfg, personId, sessionVersion) {
     return (await sessionCheckPages(cfg, personId, sessionVersion)).verdict;
 }
-/** §14 (0.4.0): the same check, with the person's pages as the Hub holds them now (absent from a Hub before §14). */
+/**
+ * §14 (0.4.0): the same check, with the person's pages as the Hub holds them now (absent from a Hub before §14);
+ * §18 (0.8.0): and the apps they may open (absent from a Hub before §18).
+ */
 export async function sessionCheckPages(cfg, personId, sessionVersion) {
     const r = await post(cfg, "/api/hub/session-check", { personId, sessionVersion });
     if (r.status === 0 || r.status >= 500)
         return { verdict: "unknown" };
     if (r.json?.ok !== true)
         return { verdict: "refused" };
-    return r.json.pages === undefined ? { verdict: "ok" } : { verdict: "ok", pages: readPages(r.json.pages) };
+    return {
+        verdict: "ok",
+        ...(r.json.pages === undefined ? {} : { pages: readPages(r.json.pages) }),
+        ...(r.json.apps === undefined ? {} : { apps: readApps(r.json.apps) }),
+    };
 }
 /** 7.3: the store's token from the Hub, cached until an hour before it expires. */
 export function tokenBroker(cfg) {

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export { Guard, openingPage, type GuardConfig, type CheckResult } from "./guard.js";
+export { appMenu, readApps, APP_ID_RE, type AppMenuItem, type HubApp } from "./apps.js";
 export { pageAllowed, pageAccess, pagesFingerprint, readPages, PAGE_KEY_RE, type PageAccess, type PageDef, type Pages } from "./pages.js";
 export { verifyTicket, JtiMemory, TICKET_ISSUER, TICKET_TTL_S, TICKET_ALG, type TicketClaims, type VerifyResult } from "./ticket.js";
 export { readSession, signSession, cookieHeader, clearCookieHeader, cookieValue, SESSION_COOKIE, IDLE_MS, ABSOLUTE_MS, RECHECK_MS, type ModuleSession } from "./session.js";

package/dist/index.js

@@ -1,4 +1,5 @@
 export { Guard, openingPage } from "./guard.js";
+export { appMenu, readApps, APP_ID_RE } from "./apps.js";
 export { pageAllowed, pageAccess, pagesFingerprint, readPages, PAGE_KEY_RE } from "./pages.js";
 export { verifyTicket, JtiMemory, TICKET_ISSUER, TICKET_TTL_S, TICKET_ALG } from "./ticket.js";
 export { readSession, signSession, cookieHeader, clearCookieHeader, cookieValue, SESSION_COOKIE, IDLE_MS, ABSOLUTE_MS, RECHECK_MS } from "./session.js";

package/dist/session.d.ts

@@ -1,3 +1,4 @@
+import type { HubApp } from "./apps.js";
 import type { Pages } from "./pages.js";
 export declare const SESSION_COOKIE = "t3b_module_session";
 export declare const IDLE_MS: number;
@@ -14,6 +15,8 @@ export type ModuleSession = {
     checkedAt: number;
     /** §14 (0.4.0): the person's pages here, from the pass, refreshed by every 15-minute check */
     pages?: Pages;
+    /** §18 (0.8.0): the apps this person may open (the Apps button), from the pass, refreshed by every 15-minute check */
+    apps?: HubApp[];
 };
 export declare function signSession(s: ModuleSession, secret: string): Promise<string>;
 export declare function readSession(cookie: string | undefined | null, secret: string, now?: number, opts?: {

package/dist/ticket.d.ts

@@ -1,3 +1,4 @@
+import { type HubApp } from "./apps.js";
 import { type Pages } from "./pages.js";
 import { type JWTVerifyGetKey } from "jose";
 export declare const TICKET_ISSUER = "t3b-hub";
@@ -15,6 +16,8 @@ export type TicketClaims = {
     exp: number;
     /** §14 (0.4.0): the person's pages in this module; `{}` from a Hub before §14 */
     pages: Pages;
+    /** §18 (0.8.0): the apps this person may open; `[]` from a Hub before §18 */
+    apps: HubApp[];
 };
 export type VerifyResult = {
     ok: true;

package/dist/ticket.js

@@ -1,3 +1,4 @@
+import { readApps } from "./apps.js";
 import { readPages } from "./pages.js";
 import { jwtVerify } from "jose";
 import { HUB_ISSUER, TYP } from "./identity.js";
@@ -60,6 +61,6 @@ export async function verifyTicket(ticket, opts) {
         return { ok: false, reason: "replayed" };
     return {
         ok: true,
-        claims: { sub: p.sub, jti: p.jti, role: p.role, stores: p.stores.map(String), path: p.path, name: String(p.name ?? ""), sv: Number(p.sv ?? 0), iat: p.iat, exp: p.exp, pages: readPages(p.pages) },
+        claims: { sub: p.sub, jti: p.jti, role: p.role, stores: p.stores.map(String), path: p.path, name: String(p.name ?? ""), sv: Number(p.sv ?? 0), iat: p.iat, exp: p.exp, pages: readPages(p.pages), apps: readApps(p.apps) },
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@t3b/hub-guard",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "description": "The3Beez Hub guard: a module opens only by a Hub-signed ticket and refuses everything else. No key from the Hub: towards the Hub the app shows its own Vercel ID; from the Hub it accepts only what is signed by the key the Hub publishes. Entry route, refusal page, module session, idle rule, 15-minute re-check, Cloudflare Access proof, broker and audit clients, manifest and health answers for the Hub only. Web Crypto only: runs in Node 20+ and in edge runtimes.",
   "license": "UNLICENSED",
   "type": "module",