@i4e/invest4edu-access-core 0.33.0 → 0.35.0

package/README.md

@@ -112,8 +112,6 @@ Model.find(q).setOptions({ skipTenant: true });          // one query
   (`/user-entity-link`) — which hats may coexist on one person
 - `ROLE_TYPE_PRIORITY`, `CLIENT_APP_ROLE_NAMES`, `pickPortalRoleName` (`/portal-roles`) —
   which role names a portal session
-- `normalizeRoute(route)`, `screenForRoute(features, route)` (`/route-screen`) — the screen row
-  a route resolves to, so a `MODULE.SCREEN.ACTION` code is read off the registry, never spelled
 
 ## Not covered
 **Aggregation pipelines** — add an explicit `{ $match: { account_id } }` stage.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@i4e/invest4edu-access-core",
-  "version": "0.33.0",
+  "version": "0.35.0",
   "description": "Shared access-control primitives for NeoFindesk: tenant keystone, role capabilities, reportee tree, entity/role vocabulary, feature flags, and the unified access engine (registry schema, snapshot resolver, visibleWhen).",
   "type": "module",
   "exports": {
@@ -21,6 +21,7 @@
     "./grid-schema": "./src/grid-schema.js",
     "./route-features": "./src/route-features.js",
     "./route-screen": "./src/route-screen.js",
+    "./report-audience": "./src/report-audience.js",
     "./subscription-lifecycle": "./src/subscription-lifecycle.js",
     "./entitlement-store": "./src/entitlement-store.js",
     "./proration": "./src/proration.js",

package/src/index.js

@@ -59,6 +59,15 @@ export {
   ACCESS_GRANT_DEF,
 } from "./access-schema.js";
 export { normalizeRoute, screenForRoute } from "./route-screen.js";
+export {
+  AUDIENCE,
+  SECTION_KEYS,
+  ALL_VISIBLE,
+  AUDIENCE_DEFAULTS,
+  classifyAudience,
+  resolveSections,
+  resolveReportAudience,
+} from "./report-audience.js";
 export {
   resolveAccessSnapshot,
   mergeGrants,

package/src/report-audience.js

@@ -0,0 +1,241 @@
+/**
+ * Portfolio report audience — who is a report FOR, and which sections may it show.
+ *
+ * A product review (Aditya, Manoj, Rozy) decided the portfolio report must show different things
+ * to different audiences: a partner's client and an employee-serviced client see a reduced,
+ * B2C-toned view (health score and storytelling, no recommendations), while an adviser working
+ * their own book keeps the full report.
+ *
+ * ── The audience is a property of the CLIENT, never the viewer ────────────────────────────────
+ * One RM opens a partner's client and a direct client in the same session, and the InvestValue
+ * mobile app is always a client viewer while its users are clients of BOTH types. So the answer
+ * is derived from the client record and obeyed identically by every renderer — NFD web, the
+ * native mobile screens, and anything that comes later.
+ *
+ * ── Why this lives in the package ─────────────────────────────────────────────────────────────
+ * The same rule is needed in v1 (which fronts the eCAS registry) and v2 (which mints the PFA
+ * subject token and answers PFA's callbacks). Two copies of a classification rule is how the two
+ * halves drift into disagreeing about what a partner's client may see — and a drift here is not a
+ * cosmetic bug: it decides what a client is shown about their own money.
+ *
+ * ── PURE, like the rest of this package ───────────────────────────────────────────────────────
+ * No Mongoose, no I/O. The two identity lookups are INJECTED, because they are the one part that
+ * genuinely differs: v1 has Mongoose models, v2 reads raw collections, and a script may have
+ * neither. Injecting them keeps the decision testable without a database and keeps the package
+ * free of every repo's model graph — the same contract `access-resolver` and `route-features`
+ * already follow.
+ *
+ * ── FAIL OPEN, ALWAYS ─────────────────────────────────────────────────────────────────────────
+ * An unknown audience, an unreadable registry, a thrown lookup — all resolve to the full report.
+ * A gating bug that blanks a working report is worse than one that shows too much, and this code
+ * sits in front of a screen clients already use.
+ *
+ * ── What this is NOT ──────────────────────────────────────────────────────────────────────────
+ * Presentation, not confidentiality. The sections withheld are the client's own portfolio data
+ * shown in less depth, and the map reaches the renderers through channels a caller can influence.
+ * It must never become the only thing standing between a viewer and data they may not see; if a
+ * genuinely must-not-see section is ever added, it needs enforcement at the data source instead.
+ * Decision recorded 10 Sep 2026.
+ *
+ * Spec: IV-CodingAgent/specs/access-management/SPEC-portfolio-report-audience.md
+ */
+
+/** Audiences. Surface-neutral: every renderer maps these to its own components. */
+export const AUDIENCE = Object.freeze({
+  PARTNER: "partner",
+  RM_E1: "rm_e1",
+  DIRECT: "direct",
+  FULL: "full",
+});
+
+/**
+ * Section keys. Deliberately named for WHAT they are, not for the component that renders them,
+ * because independent renderers consume this: nfd-ui gates React components, the mobile app
+ * filters its tab array. A key named after either one would read as foreign in the other.
+ *
+ * `healthScore` has no entry: the gauge is the one thing every audience keeps, so it is never
+ * gated. Making it configurable would invite a state where the report shows nothing at all.
+ */
+export const SECTION_KEYS = Object.freeze([
+  "actions", // the 3-step action plan / recommendations
+  "phc", // portfolio health-check detail body
+  "chat", // AI chat
+  "performance", // performance / gains
+  "keyInsights",
+  "fundAnalysis", // the fund analysis table
+  "scoreBreakdownFunds", // underlying funds inside the score breakdown
+  "advisorCta", // "call your advisor" prompt
+]);
+
+/** Everything on. The answer whenever we cannot prove a narrower one is correct. */
+export const ALL_VISIBLE = Object.freeze({
+  actions: true,
+  phc: true,
+  chat: true,
+  performance: true,
+  keyInsights: true,
+  fundAnalysis: true,
+  scoreBreakdownFunds: true,
+  advisorCta: false, // opt-in, not part of "everything"
+  fundDetail: "full",
+  tone: "adviser",
+});
+
+/** The reduced view. Partner and RM-E1 clients get exactly this; direct adds the CTA. */
+const REDUCED = Object.freeze({
+  actions: false,
+  phc: false,
+  chat: false,
+  performance: false,
+  keyInsights: false,
+  fundAnalysis: false,
+  scoreBreakdownFunds: false,
+  advisorCta: false,
+  fundDetail: "minimal",
+  tone: "b2c",
+});
+
+/**
+ * Defaults encode the review notes. They are the FALLBACK, not the source of truth — the registry
+ * overrides them per feature. They exist so the resolver still answers correctly before the
+ * registry rows are seeded, and when the registry cannot be read.
+ */
+export const AUDIENCE_DEFAULTS = Object.freeze({
+  [AUDIENCE.FULL]: ALL_VISIBLE,
+
+  /*
+   * REVISED 12 Sep 2026 (Peeyush). The first cut reduced all three audiences and differed only by
+   * a CTA. It now reduces ONE.
+   *
+   *   partner  full — unlocking a partner's client is out of scope, so gating them would leave a
+   *            reduced report with no way to ever open it.
+   *   direct   full — a direct client has no partner and no servicing RM, so there is nobody for
+   *            "ask your advisor" to point at.
+   *   rm_e1    reduced — an employee services this client, so the withheld sections have an owner
+   *            who can walk the client through them.
+   *
+   * Measured on prod the day this changed: 13,327 partner, 2,121 e1, 232 direct of 15,680. So the
+   * feature applies to ~13.5% of the book and 86.5% is untouched.
+   */
+  [AUDIENCE.PARTNER]: ALL_VISIBLE,
+
+  // "Don't show for RM clients where RM is E1. Actions will not come. Portfolio Health Score
+  //  component — don't show; only show Health Score, no recommendations. Hide the AI chatbot.
+  //  Remove Key / Fund Analysis. Hide Performance. Less fund details. Score breakdown — remove
+  //  underlying fund. Language B2C / neutral."
+  //
+  // The CTA rides HERE rather than on `direct`, inverting the first cut: this is the audience
+  // with an adviser to talk to, and the one whose sections are withheld.
+  [AUDIENCE.RM_E1]: Object.freeze({ ...REDUCED, advisorCta: true }),
+
+  [AUDIENCE.DIRECT]: ALL_VISIBLE,
+});
+
+const E1_TYPE_DISTRIBUTOR = "distributor";
+
+/** A lookup that was not supplied, or threw, proves nothing. Never let it throw upward. */
+async function safeAsk(fn, id) {
+  if (typeof fn !== "function") return false;
+  try {
+    return !!(await fn(id));
+  } catch {
+    return false;
+  }
+}
+
+/**
+ * Classify a client record into an audience.
+ *
+ * `e1_type` is a HINT and is treated as one — the same rule `shapePersonFilterOptions` follows,
+ * for the same reason: on devpoc 66 rows carry a type that disagrees with the collection the id is
+ * actually in (29 on dev), and those rows predate the field being declared. So both collections
+ * are consulted and the hint only decides which answer wins when both could be true. Trusting the
+ * enum bare would misclassify exactly those rows — and misclassifying is how a partner's client
+ * ends up seeing an adviser's report.
+ *
+ * @param {{ distributor_id?: *, e1?: *, e1_type?: string }} client
+ * @param {Object} [lookups]
+ * @param {(id: *) => Promise<boolean>} [lookups.isEmployee]     does this id name an employee-backed user?
+ * @param {(id: *) => Promise<boolean>} [lookups.isDistributor]  does this id name a real distributor?
+ * @returns {Promise<'partner'|'rm_e1'|'direct'>}
+ */
+export async function classifyAudience(client, lookups = {}) {
+  if (!client) return AUDIENCE.DIRECT;
+
+  // A client sitting in a partner's book is a partner client, whatever E1 says. This is the
+  // strongest signal we have and it is a plain field — house clients were moved to direct by
+  // nulling it (dedup, Aug 2026), so `null` genuinely means "not a partner's".
+  if (client.distributor_id) return AUDIENCE.PARTNER;
+
+  const { e1 } = client;
+  if (!e1) return AUDIENCE.DIRECT;
+
+  // Ask both, then let the hint break the tie — never the other way round.
+  const [employee, distributor] = await Promise.all([
+    safeAsk(lookups.isEmployee, e1),
+    safeAsk(lookups.isDistributor, e1),
+  ]);
+
+  if (employee && distributor) {
+    return client.e1_type === E1_TYPE_DISTRIBUTOR ? AUDIENCE.PARTNER : AUDIENCE.RM_E1;
+  }
+  if (employee) return AUDIENCE.RM_E1;
+  if (distributor) return AUDIENCE.PARTNER;
+
+  // An E1 resolving to nobody (deleted user, another account's distributor) is exactly the
+  // bad-data case above. Fall back to the reduced-but-safe audience rather than to `full`.
+  return AUDIENCE.DIRECT;
+}
+
+/**
+ * Merge registry overrides over the audience defaults.
+ *
+ * The registry is the source of truth for WHICH sections exist and whether each is on; the
+ * defaults answer while the rows are unseeded. `loadOverrides` is injected rather than imported so
+ * this module stays free of the access models — and so a caller with no registry at all (the
+ * mobile path has no access snapshot: no roles, no grants) can skip the read entirely without a
+ * second code path.
+ *
+ * @param {string} audience
+ * @param {(audience: string) => Promise<Object|null>} [loadOverrides]
+ */
+export async function resolveSections(audience, loadOverrides) {
+  const base = AUDIENCE_DEFAULTS[audience] || ALL_VISIBLE;
+  if (typeof loadOverrides !== "function") return { ...base };
+  try {
+    const overrides = await loadOverrides(audience);
+    return overrides && typeof overrides === "object" ? { ...base, ...overrides } : { ...base };
+  } catch {
+    return { ...base }; // registry unreadable → the audience default still applies
+  }
+}
+
+/**
+ * The one entry point callers use: classify, resolve, and never throw.
+ *
+ * @param {Object} client                                     client-ish record (distributor_id, e1, e1_type)
+ * @param {Object} [opts]
+ * @param {(id: *) => Promise<boolean>} [opts.isEmployee]
+ * @param {(id: *) => Promise<boolean>} [opts.isDistributor]
+ * @param {(audience: string) => Promise<Object|null>} [opts.loadOverrides]
+ * @returns {Promise<{ audience: string, sections: Object }>}
+ */
+export async function resolveReportAudience(client, opts = {}) {
+  try {
+    const audience = await classifyAudience(client, opts);
+    return { audience, sections: await resolveSections(audience, opts.loadOverrides) };
+  } catch {
+    // Fail open. Every caller renders a report from this; none of them should render nothing.
+    return { audience: AUDIENCE.FULL, sections: { ...ALL_VISIBLE } };
+  }
+}
+
+export default {
+  AUDIENCE,
+  SECTION_KEYS,
+  ALL_VISIBLE,
+  AUDIENCE_DEFAULTS,
+  classifyAudience,
+  resolveSections,
+  resolveReportAudience,
+};