@aglyn/tenant-data-admin 1.0.0-beta.218 → 1.0.0-beta.220

package/src/lib/server/risk-notice.js

@@ -57,8 +57,8 @@ import { _ as _extends } from "@swc/helpers/_/_extends";
  * short "more are arriving" note in-app; when the hour closes,
  * {@link flushRiskNoticeDigests} (hourly cron, and the next notice after the
  * window) sends ONE summary. A workspace under attack gets a digest, not
- * five hundred emails. Locks, lifts and cancellations (`neverDigest`) always
- * go out on their own.
+ * five hundred emails. Locks, lifts, cancellations, disputes and card-testing
+ * warnings (`neverDigest`) always go out on their own.
  *
  * ## Never throws
  *
@@ -68,7 +68,8 @@ import { _ as _extends } from "@swc/helpers/_/_extends";
  *=========================================*/ import { createHash } from "crypto";
 import { ABUSE_REPORT_COLLECTION, abuseReportContactEmail } from "@aglyn/aglyn/app-utils/abuse-report";
 import { DOCS_BASE_URL } from "@aglyn/aglyn/app-utils/docs-help";
-import { isRiskEventKind, renderOwnerRiskNotice, renderRiskNoticeText, renderStaffRiskNotice, resolveOwnerRiskActions, RISK_NOTICE_CATALOG, RISK_NOTICE_CLOSING_KINDS, RISK_NOTICE_DIGEST_EMAIL_KEY, RISK_NOTICE_HELP_PATH, RISK_NOTICE_WORKSPACE_BRANDED, riskNoticeEmailKey } from "@aglyn/shared-util-email/risk-notice-catalog";
+import { PLATFORM_BRAND_MERGE_TOKENS } from "@aglyn/aglyn/app-utils/system-email-chrome";
+import { isRiskEventKind, renderOwnerRiskNotice, renderRiskNoticeText, renderStaffRiskNotice, resolveOwnerRiskActions, RISK_NOTICE_CATALOG, RISK_NOTICE_CLOSING_KINDS, RISK_NOTICE_DIGEST_EMAIL_KEY, RISK_NOTICE_HELP_PATH, RISK_NOTICE_WORKSPACE_BRANDED, riskNoticeEmailKey, riskPayoutDelayText } from "@aglyn/shared-util-email/risk-notice-catalog";
 import { sendEmail as sendEmailImpl } from "@aglyn/shared-util-email";
 import { heldPageDetails, heldPageLabel, heldPageTargets, heldPageVisitorSentence, isOpenPageHoldStatus, isPageHoldNoticeKind, PAGE_HOLD_NOTICE_KINDS, pageHoldChip, parseHeldPageItemPath } from "@aglyn/shared-util-email/held-page";
 import { FieldValue } from "firebase-admin/firestore";
@@ -82,6 +83,14 @@ import { RISK_REVIEW_REQUESTED_EMAIL_KEY } from "@aglyn/shared-util-email/risk-n
 /** Admin-SDK only; no client rule opens it. One document per notice. */ export const RISK_NOTICE_COLLECTION = 'riskNotices';
 /** Admin-SDK only: each workspace's burst window and folded notices. */ export const RISK_NOTICE_LEDGER_COLLECTION = 'riskNoticeLedger';
 /** The in-app notification type every owner notice is written as. */ export const RISK_NOTICE_NOTIFICATION_TYPE = 'system.riskNotice';
+/**
+ * The level an owner notice is drawn at (AGL-3437), from its kind's
+ * severity: a release or a lift is `info`, not the red of the hold it ends.
+ */ export const RISK_NOTICE_LEVELS = {
+    urgent: 'critical',
+    warning: 'warning',
+    info: 'info'
+};
 /**
  * The burst allowance: how many notices one workspace's owners, and staff
  * about one workspace, receive one by one in {@link RISK_NOTICE_BURST.windowMs}
@@ -249,12 +258,19 @@ function consoleOrigin() {
     var _input_orgId;
     let orgId = (_input_orgId = input.orgId) != null ? _input_orgId : null;
     let hostSubdomain = null;
+    let siteLabel = null;
     let siteManagerUids = [];
     if (input.hostId) {
         const host = await firestore.collection('hosts').doc(input.hostId).get().catch(()=>null);
         if (host == null ? void 0 : host.exists) {
-            var _host_get, _host_get1, _host_get2;
+            var _host_get, _map_find, _host_get1, _host_get2;
             hostSubdomain = String((_host_get = host.get('subdomain')) != null ? _host_get : '') || null;
+            const siteName = (_map_find = [
+                host.get('displayName'),
+                host.get('name'),
+                hostSubdomain
+            ].map((value)=>typeof value === 'string' ? value.trim() : '').find(Boolean)) != null ? _map_find : '';
+            siteLabel = siteName ? `the site "${siteName.replace(/"/g, '”')}"` : null;
             orgId = orgId != null ? orgId : String((_host_get1 = host.get('orgId')) != null ? _host_get1 : '') || null;
             const roles = (_host_get2 = host.get('memberRoles')) != null ? _host_get2 : {};
             siteManagerUids = Object.entries(roles).filter(([, role])=>role === 'admin' || role === 'editor').map(([uid])=>uid);
@@ -275,6 +291,7 @@ function consoleOrigin() {
         orgName,
         orgSlug,
         hostSubdomain,
+        siteLabel,
         siteManagerUids
     };
 }
@@ -285,6 +302,15 @@ function consoleOrigin() {
  */ export async function riskNoticeEmailBrand(kind, orgId) {
     return kind && RISK_NOTICE_WORKSPACE_BRANDED.has(kind) ? orgSystemEmailBrand(orgId) : systemEmailBrand(null);
 }
+/**
+ * The product name a notice's own words use (`your Aglyn account`): the one
+ * the email it rides in is branded with, so the sentence and the header
+ * never disagree — the platform's for platform mail, a white-label
+ * workspace's own for the notices sent in its brand.
+ */ export function riskNoticeProductName(brand) {
+    var _brand_merge_brandproductName, _PLATFORM_BRAND_MERGE_TOKENS_brandproductName;
+    return String((_brand_merge_brandproductName = brand.merge['brand.productName']) != null ? _brand_merge_brandproductName : '').trim() || String((_PLATFORM_BRAND_MERGE_TOKENS_brandproductName = PLATFORM_BRAND_MERGE_TOKENS['brand.productName']) != null ? _PLATFORM_BRAND_MERGE_TOKENS_brandproductName : '').trim();
+}
 /**
  * Renders one notice email through the System emails seam (AGL-3367): the
  * published design for the kind's own `risk-…` key, or its built-in copy,
@@ -429,7 +455,11 @@ function emptyDelivery(skipped = null) {
             if (owner.email) emails[owner.uid] = owner.email;
         }
     }
-    if (definition.includeSiteManagers) for (const uid of siteManagerUids)uids.add(uid);
+    // A closing kind is shared by openings with different audiences, so it
+    // follows the one it closes: a site manager told a review opened is told
+    // it closed.
+    const audience = isRiskEventKind(input.openedAs) ? RISK_NOTICE_CATALOG[input.openedAs] : definition;
+    if (audience.includeSiteManagers) for (const uid of siteManagerUids)uids.add(uid);
     return {
         uids: [
             ...uids
@@ -469,7 +499,7 @@ function emptyDelivery(skipped = null) {
     const noticeId = riskNoticeId(riskNoticeDedupeKey(input, occurredAtMs));
     result.noticeId = noticeId;
     try {
-        var _abuseReportContactEmail, _ref1, _input_reference, _ref2, _ref3, _input_amount, _context_orgName, _input_staffEvidence, _ref4, _input_reviewId, _input_hostId, _input_stripeUrl, _ref5, _ref6, _ownerActions_find;
+        var _abuseReportContactEmail, _ref1, _input_reference, _ref2, _ref3, _input_amount, _input_paymentEvent, _context_orgName, _input_staffEvidence, _ref4, _input_reviewId, _input_hostId, _input_stripeUrl, _ref5, _ref6, _ownerActions_find;
         var _input_item, _input_lock, _input_lock1, _input_item1, _input_lock2, _input_lock3;
         const context = await readContext(deps.firestore, input);
         const orgId = context.orgId;
@@ -480,8 +510,12 @@ function emptyDelivery(skipped = null) {
      * The values the OWNER half renders with. `staff.evidence` is absent by
      * construction: the owner record and the owner channels never hold it.
      */ const supportEmail = (_abuseReportContactEmail = abuseReportContactEmail('support')) != null ? _abuseReportContactEmail : '';
+        // The brand the email is sent in, read once: its product name is also a
+        // word in the notice (an account lock says whose account it is).
+        const brand = await riskNoticeEmailBrand(input.kind, orgId);
         const ownerValues = {
             'workspace.name': context.orgName,
+            'site.label': context.siteLabel,
             'item.label': (_ref1 = (_input_item = input.item) == null ? void 0 : _input_item.label) != null ? _ref1 : null,
             occurredAt: formatRiskNoticeTime(occurredAtMs),
             reference: (_input_reference = input.reference) != null ? _input_reference : null,
@@ -489,7 +523,11 @@ function emptyDelivery(skipped = null) {
             'lock.message': (_ref2 = (_input_lock = input.lock) == null ? void 0 : _input_lock.message) != null ? _ref2 : null,
             'lock.affected': (_ref3 = (_input_lock1 = input.lock) == null ? void 0 : _input_lock1.affected) != null ? _ref3 : null,
             amount: (_input_amount = input.amount) != null ? _input_amount : null,
-            'evidence.dueBy': input.evidenceDueByMs ? formatRiskNoticeTime(input.evidenceDueByMs) : null
+            'payment.event': (_input_paymentEvent = input.paymentEvent) != null ? _input_paymentEvent : null,
+            'evidence.dueBy': input.evidenceDueByMs ? formatRiskNoticeTime(input.evidenceDueByMs) : null,
+            'payout.delay': input.payout ? riskPayoutDelayText(input.payout) : null,
+            'page.visitors': input.page ? heldPageVisitorSentence(input.page) : null,
+            'brand.productName': riskNoticeProductName(brand) || null
         };
         const staffValues = _extends({}, ownerValues, {
             'workspace.name': (_context_orgName = context.orgName) != null ? _context_orgName : orgId,
@@ -578,6 +616,7 @@ function emptyDelivery(skipped = null) {
                     type: RISK_NOTICE_NOTIFICATION_TYPE,
                     title: owner.title,
                     body: `${owner.summary} ${owner.meaning}`.slice(0, 1000),
+                    level: RISK_NOTICE_LEVELS[definition.severity],
                     link: (_ref9 = primary == null ? void 0 : primary.href) != null ? _ref9 : riskHoldsPath(noticeId)
                 }, orgId ? {
                     orgId
@@ -613,7 +652,7 @@ function emptyDelivery(skipped = null) {
                     workspaceName: context.orgName,
                     lockMessage: (_ref10 = (_input_lock4 = input.lock) == null ? void 0 : _input_lock4.message) != null ? _ref10 : null
                 });
-                const rendered = await renderRiskNoticeEmail(riskNoticeEmailKey(input.kind), merge, await riskNoticeEmailBrand(input.kind, orgId));
+                const rendered = await renderRiskNoticeEmail(riskNoticeEmailKey(input.kind), merge, brand);
                 const delivery = await emailPeople(deps, recipients, rendered, supportEmail, {
                     lockNotice: LOCK_NOTICE_KINDS.has(input.kind)
                 });
@@ -629,6 +668,7 @@ function emptyDelivery(skipped = null) {
                 await deps.notifyUsers(recipients.uids, _extends({
                     type: RISK_NOTICE_NOTIFICATION_TYPE,
                     title: 'More account notices are arriving',
+                    level: 'warning',
                     body: 'Several items on your workspace were held or flagged in the last hour. ' + 'We will send one summary instead of a message for each. Every item is listed on Holds & reviews.',
                     link: riskHoldsPath()
                 }, orgId ? {
@@ -818,18 +858,17 @@ function isAlreadyExists(error) {
         if (count > listed) lines.push(`• …and ${count - listed} more`);
         return lines.join('\n');
     };
+    // The workspace by name, for both halves: staff read a digest about
+    // `Harbor View`, not about a ledger key.
+    const context = orgId ? await readContext(deps.firestore, {
+        kind: 'email-held',
+        orgId
+    }) : {
+        orgName: null,
+        orgSlug: null
+    };
     if (taken.ownerCount > 0) {
         var _context_orgName;
-        const context = orgId ? await readContext(deps.firestore, {
-            kind: 'email-held',
-            orgId
-        }) : {
-            orgName: null,
-            orgSlug: null,
-            siteManagerUids: [],
-            orgId: null,
-            hostSubdomain: null
-        };
         const recipients = scope === 'user' ? {
             uids: [
                 id
@@ -842,7 +881,7 @@ function isAlreadyExists(error) {
             uids: [],
             emails: {}
         };
-        const title = `Summary: more items on ${(_context_orgName = context.orgName) != null ? _context_orgName : 'your workspace'} were held or flagged`;
+        const title = `Summary: more notices about ${(_context_orgName = context.orgName) != null ? _context_orgName : 'your workspace'} in the last hour`;
         const summary = summarize(taken.owners, taken.ownerCount);
         if (recipients.uids.length) {
             var _context_orgName1, _abuseReportContactEmail;
@@ -850,6 +889,7 @@ function isAlreadyExists(error) {
                 type: RISK_NOTICE_NOTIFICATION_TYPE,
                 title,
                 body: summary.slice(0, 1000),
+                level: 'warning',
                 link: riskHoldsPath()
             }, orgId ? {
                 orgId
@@ -863,7 +903,7 @@ function isAlreadyExists(error) {
             });
             const rendered = await renderRiskNoticeEmail(RISK_NOTICE_DIGEST_EMAIL_KEY, {
                 'notice.title': title,
-                'notice.summary': renderRiskNoticeText('In the last hour, more items on {{workspace.name}} were held or flagged than we send one by one:', {
+                'notice.summary': renderRiskNoticeText('In the last hour, {{workspace.name}} had more notices than we send one by one. Each one, with its status and anything that is due, is listed on Holds & reviews. By title:', {
                     'workspace.name': context.orgName
                 }),
                 'notice.meaning': summary,
@@ -881,10 +921,12 @@ function isAlreadyExists(error) {
         }
     }
     if (taken.staffCount > 0) {
+        var _context_orgName2;
+        const about = context.orgName ? `workspace ${context.orgName} (${orgId})` : scope === 'user' ? `account ${id}` : scope === 'host' ? `site ${id}` : ledgerId;
         await deps.notifyStaff({
             type: 'system.abuseReportUrgent',
-            title: `Digest: ${taken.staffCount} more risk alerts on ${ledgerId}`,
-            body: summarize(taken.staff, taken.staffCount).slice(0, 1000),
+            title: `Digest: ${taken.staffCount} more risk alerts on ${(_context_orgName2 = context.orgName) != null ? _context_orgName2 : ledgerId}`,
+            body: (`${taken.staffCount} more risk alerts on ${about} arrived in the last hour ` + `and were batched here instead of sent one by one:\n` + summarize(taken.staff, taken.staffCount)).slice(0, 1000),
             link: '/admin/abuse-reports'
         });
     }
@@ -942,7 +984,8 @@ function isAlreadyExists(error) {
                 label: stamp.itemLabel,
                 path: (_stamp_itemPath = stamp.itemPath) != null ? _stamp_itemPath : null
             } : null,
-            dedupeKey: `${closing}:${input.reviewId}`
+            dedupeKey: `${closing}:${input.reviewId}`,
+            openedAs: stamp.kind
         }, overrides);
     } catch (error) {
         console.error('[risk-notice] the closing notice failed', error);
@@ -957,7 +1000,8 @@ function isAlreadyExists(error) {
  * here, so no request can release a hold or lift a lock. Staff see the
  * request as a note on the row, and are notified with a link to it.
  */ export async function requestRiskReview(input, overrides = {}) {
-    var _input_note, _notice_get;
+    var _input_note, _notice_get, _ref, _ref1, _ref2;
+    var _notice_get1;
     const deps = resolveDeps(overrides);
     const note = String((_input_note = input.note) != null ? _input_note : '').trim().slice(0, RISK_REVIEW_NOTE_MAX);
     if (note.length < 10) {
@@ -1031,23 +1075,41 @@ function isAlreadyExists(error) {
             error: 'We already have a request on this. You can add another in a few minutes.'
         };
     }
+    // What the request is about, by name, for staff and for the person who
+    // asked: the item in the owner's words and the workspace.
+    const itemLabel = String((_ref = (_notice_get1 = notice.get('ownerValues')) == null ? void 0 : _notice_get1['item.label']) != null ? _ref : '').trim() || null;
+    const org = await deps.firestore.collection('orgs').doc(input.orgId).get().catch(()=>null);
+    const orgName = String((_ref1 = org == null ? void 0 : org.get('name')) != null ? _ref1 : '').trim() || null;
+    const orgSlug = String((_ref2 = org == null ? void 0 : org.get('slug')) != null ? _ref2 : '').trim() || null;
     await deps.notifyStaff({
         type: 'system.abuseReportUrgent',
         title: `Review requested${outcome.reference ? ` — ${outcome.reference}` : ''}`,
-        body: `A workspace owner or admin asked for a review: "${note.slice(0, 280)}"`,
+        body: `An owner or admin of ${orgName ? `${orgName} (${input.orgId})` : `workspace ${input.orgId}`} ` + `asked for a review of ${itemLabel != null ? itemLabel : 'a held or flagged item'} (${kind}): "${note.slice(0, 280)}"`,
         link: staffAbuseRowPath(reviewId)
     });
     // The person who asked is told it arrived — account mail, platform brand.
     if (input.email) {
         var _outcome_reference, _abuseReportContactEmail;
+        const holdsPath = emailPath(riskHoldsPath(input.noticeId), {
+            orgSlug,
+            hostId: null,
+            hostSubdomain: null
+        });
+        const holdsUrl = holdsPath ? absolute(holdsPath) : '';
+        const about = `${itemLabel != null ? itemLabel : 'the held or flagged item'}${orgName ? ` on ${orgName}` : ''}`;
         const rendered = await renderRiskNoticeEmail(RISK_REVIEW_REQUESTED_EMAIL_KEY, {
             'notice.title': 'We received your review request',
-            'notice.summary': 'Your request reached our review team' + (outcome.reference ? ` under the reference ${outcome.reference}` : '') + '. A person reads every request.',
-            'notice.meaning': 'Nothing changes until the review is done; you will get a notice either way.',
+            'notice.summary': `We received your request to review ${about}` + (outcome.reference ? ` (reference ${outcome.reference})` : '') + '. A person on our review team reads every request.',
+            'notice.meaning': 'Nothing changes until the review is done, and you will get a notice either way.',
             'notice.steps': numbered([
                 'Nothing more is needed.',
-                'You can follow the item\'s status on Holds & reviews.'
+                'You can follow its status on Holds & reviews.'
             ]),
+            'notice.actions': holdsUrl ? `View holds and reviews: ${holdsUrl}` : '',
+            'notice.primaryActionLabel': holdsUrl ? 'View holds and reviews' : '',
+            'notice.primaryActionUrl': holdsUrl,
+            'holds.url': holdsUrl,
+            'workspace.name': orgName != null ? orgName : '',
             reference: (_outcome_reference = outcome.reference) != null ? _outcome_reference : '',
             'help.url': riskNoticeHelpUrl('requesting-a-review')
         });