@aglyn/tenant-data-admin 1.0.0-beta.289 → 1.0.0-beta.291
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +7 -7
- package/src/lib/server/account-acquisition.js +19 -3
- package/src/lib/server/account-acquisition.js.map +1 -1
- package/src/lib/server/email-suppression.d.ts +40 -0
- package/src/lib/server/email-suppression.js +47 -0
- package/src/lib/server/email-suppression.js.map +1 -1
- package/src/lib/server/platform-marketing-consent.d.ts +33 -0
- package/src/lib/server/platform-marketing-consent.js +58 -0
- package/src/lib/server/platform-marketing-consent.js.map +1 -1
- package/src/lib/server/platform-served-domain.d.ts +60 -0
- package/src/lib/server/platform-served-domain.js +146 -0
- package/src/lib/server/platform-served-domain.js.map +1 -0
- package/src/lib/server/visitor-upload.d.ts +169 -0
- package/src/lib/server/visitor-upload.js +366 -0
- package/src/lib/server/visitor-upload.js.map +1 -0
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../../../../../../../libs/tenant/data/admin/src/lib/server/platform-marketing-consent.ts"],"sourcesContent":["/**\n * @license\n * Copyright 2026 Aglyn LLC\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n/**\n * The record a console door writes when a person decides about the\n * platform's own product email (AGL-3185).\n *\n * ## Two documents, one decision\n *\n * The decision goes onto the person's own `users/{uid}` first — the console\n * shows the preference from there, and it must not depend on the operator's\n * CRM accepting a row — and then onto the operator's marketing contact for\n * the same address through `upsertHostContact`, which is every other capture\n * door's path and the only one the send-time consent join reads. The contact\n * half carries the decision AND its provenance, so a campaign's audience\n * count reports this basis as the person's own click and never as something\n * asserted on their behalf.\n *\n * ## Server-side, because the client cannot and should not\n *\n * The sign-up page is a client of the person's own project; the operator's\n * marketing org is somebody else's data. Only the Admin SDK writes there, and\n * only after the person's ID token has been verified by the route in front\n * of this module. The user-document half could be a client write — the rules\n * make it owner-writable — but a mirror the client writes and the server\n * reads back is two writers of one fact, so both halves are written here.\n *\n * ## Which host, and why it is a setting\n *\n * The marketing host is the deployment's, not the code's: this repository is\n * what a self-hosted install runs, and an install with no product audience of\n * its own has nowhere for a contact to go. `PLATFORM_MARKETING_HOST_ID` names\n * it, and when it is unset the decision is recorded on the person's document\n * alone. No hostname or document id is hardcoded here for the same reason\n * `platform-marketing-host.ts` gives: nothing in the code knows which site\n * is the operator's.\n *\n * ## The site's own pages answer the same question, for one list (AGL-3305)\n *\n * The marketing site's emails carry their own way out, and it writes the\n * site's lists, not either consent record. An unsubscribe that was about the\n * list the console's question stands for — `PLATFORM_MARKETING_TOPIC_ID`, or\n * everything the site sends — is mirrored onto the ACCOUNT here, through an\n * email door; an unsubscribe from any other list is not, because the person\n * said nothing about product updates. The contact is left alone on purpose:\n * its basis covers every list the site sends, and declining it would stop the\n * newsletter for somebody who only left product updates.\n *\n * The console's switch undoes it the same way, one list wide: a Yes from a\n * verified account asks the plugin that keeps the site's preferences to\n * reopen that list and nothing else (`plugin-email-streams`).\n */\n\nimport { stampRecordOrigin } from '@aglyn/aglyn/plugin-manager/plugin-record-origin'\nimport {\n readTopicSubscriptionState,\n TOPIC_OPT_OUTS_SUBCOLLECTION,\n type TopicSubscriptionEntry,\n type TopicSubscriptionState,\n} from '@aglyn/aglyn/app-utils/subscription-topics'\nimport {\n isPlatformMarketingConsentDecision,\n isPlatformMarketingConsoleSourceKind,\n isPlatformMarketingEmailSourceKind,\n type PlatformMarketingConsentDecision,\n type PlatformMarketingConsoleSourceKind,\n type PlatformMarketingConsentState,\n platformMarketingConsentSource,\n platformMarketingEmailSource,\n PLATFORM_MARKETING_TOPIC_ID,\n platformMarketingUserFields,\n readPlatformMarketingConsent,\n USER_MARKETING_PROMPT_DISMISSED_AT_FIELD,\n} from '@aglyn/aglyn/app-utils/platform-marketing-consent'\nimport {\n marketingConsentDecision,\n type MarketingBasis,\n type MarketingConsentAssertedBy,\n type MarketingConsentReason,\n type MarketingConsentVerdict,\n readMarketingBasis,\n resolveMarketingConsentPolicy,\n} from '@aglyn/aglyn/app-utils/marketing-consent'\nimport {\n type EmailStreamRejoinOutcome,\n rejoinEmailStream,\n} from '@aglyn/aglyn/plugin-manager/plugin-email-streams'\nimport { attributableAccountForAddress } from './account-addresses'\nimport { findPluginPerson } from '@aglyn/aglyn/plugin-manager/plugin-person-records'\nimport {\n EMAIL_SUPPRESSIONS_COLLECTION,\n emailSuppressionKey,\n HOST_SUPPRESSIONS_SUBCOLLECTION,\n} from './email-suppression'\nimport firebaseAdmin from './firebase-admin'\nimport { consentGroupForSite, getOrgForHost } from './organizations'\nimport { upsertHostContact } from './upsert-contact'\n\nconst firestore = () => firebaseAdmin.app().firestore()\n\n/**\n * The variable naming the host whose contacts receive product-marketing\n * consent — the operator's own marketing site. Unset on a self-hosted\n * install, and honored as \"record the preference, capture no contact\".\n */\nexport const PLATFORM_MARKETING_HOST_ID_ENV = 'PLATFORM_MARKETING_HOST_ID'\n\n/**\n * The configured marketing host, or `null` when the deployment names none.\n *\n * Read at call time rather than at module load, so a test can set it and a\n * process that started without it picks up a later value the same way every\n * other runtime setting here does.\n */\nexport function platformMarketingHostId(): string | null {\n const value = String(process.env.PLATFORM_MARKETING_HOST_ID ?? '').trim()\n return value || null\n}\n\n/** What became of the contact half of the record. */\nexport type PlatformMarketingContactOutcome =\n | { status: 'recorded'; contactId: string; created: boolean }\n /** No marketing host is configured — a self-hosted install. */\n | { status: 'unconfigured' }\n /** The account carries no address a contact could be keyed on. */\n | { status: 'no-email' }\n /** The capture door refused the row — its band, an erasure, or an error. */\n | { status: 'refused'; reason: string }\n\nexport interface RecordPlatformMarketingConsentInput {\n uid: string\n /** The account's address, from the verified token. */\n email: string | null | undefined\n /** The name the token carries, for an account whose document holds none. */\n name?: string | null\n decision: PlatformMarketingConsentDecision\n /** A console door. An email door is recorded by the site's own pages. */\n source: PlatformMarketingConsoleSourceKind\n /** The wording version the door showed, stamped by the route. */\n textVersion: string\n /**\n * Whether the token proves the caller holds the mailbox — its email is\n * verified (AGL-3305). Only then does a Yes reopen the list on the\n * marketing site, because reopening it reverses what somebody did from\n * that mailbox; an unverified account could name a stranger's address.\n */\n mailboxVerified?: boolean\n /** Injectable for tests; defaults to the clock. */\n now?: number\n /** Injectable for tests; defaults to the admin app's Firestore. */\n firestore?: any\n /** Injectable for tests; defaults to {@link platformMarketingHostId}. */\n hostId?: string | null\n /** Injectable for tests; defaults to the real capture door. */\n upsert?: typeof upsertHostContact\n /** Injectable for tests; defaults to the `plugin-email-streams` slot. */\n rejoin?: typeof rejoinEmailStream\n}\n\n/**\n * What a Yes did to the marketing site's own lists (AGL-3305). Absent for a\n * No, and whenever there is no site or no address to reopen a list for.\n */\nexport type PlatformMarketingStreamOutcome =\n | EmailStreamRejoinOutcome\n /** The token does not prove the mailbox, so nothing was reopened. */\n | { status: 'unverified' }\n\nexport interface RecordPlatformMarketingConsentResult {\n /** The timestamp both documents carry. */\n atMs: number\n contact: PlatformMarketingContactOutcome\n stream?: PlatformMarketingStreamOutcome\n}\n\n/**\n * The name the person's own document holds, else the one the caller has.\n *\n * The sign-up form writes `firstName`/`lastName` onto the document; a Google\n * account carries its name on the token instead. Either is the name the\n * contact row should show, and a blank is left blank rather than invented.\n */\nfunction accountName(\n snapshot: { get?: (field: string) => unknown } | null | undefined,\n fallback: string | null | undefined,\n): string | undefined {\n const first = String(snapshot?.get?.('firstName') ?? '').trim()\n const last = String(snapshot?.get?.('lastName') ?? '').trim()\n const stored = [first, last].filter(Boolean).join(' ')\n return stored || String(fallback ?? '').trim() || undefined\n}\n\n/**\n * Records a decision on both documents.\n *\n * Loud on bad input, like `recordLegalAcceptance`: a decision that cannot be\n * attributed to an account, a door and a wording is not a record of anything.\n * Quiet on the contact half — a refused row is returned, not thrown — because\n * the person's own preference has already been recorded by then, and the\n * operator's CRM band is not a reason to tell them their choice failed.\n */\nexport async function recordPlatformMarketingConsent(\n input: RecordPlatformMarketingConsentInput,\n): Promise<RecordPlatformMarketingConsentResult> {\n const uid = String(input.uid ?? '').trim()\n if (!uid) throw new Error('recordPlatformMarketingConsent: uid is required')\n if (!isPlatformMarketingConsentDecision(input.decision)) {\n throw new Error('recordPlatformMarketingConsent: decision is required')\n }\n if (!isPlatformMarketingConsoleSourceKind(input.source)) {\n throw new Error('recordPlatformMarketingConsent: a console source is required')\n }\n const textVersion = String(input.textVersion ?? '').trim()\n if (!textVersion) {\n throw new Error('recordPlatformMarketingConsent: textVersion is required')\n }\n\n const atMs = input.now ?? Date.now()\n const source = platformMarketingConsentSource({\n kind: input.source,\n decision: input.decision,\n uid,\n atMs,\n textVersion,\n })\n\n const userRef = (input.firestore ?? firestore()).collection('users').doc(uid)\n const snapshot = await userRef.get()\n await userRef.set(\n platformMarketingUserFields({ decision: input.decision, atMs, source }),\n { merge: true },\n )\n\n const hostId =\n input.hostId === undefined ? platformMarketingHostId() : input.hostId\n if (!hostId) return { atMs, contact: { status: 'unconfigured' } }\n const email = String(input.email ?? '').trim()\n if (!email) return { atMs, contact: { status: 'no-email' } }\n\n const name = accountName(snapshot, input.name)\n const verdict = await (input.upsert ?? upsertHostContact)({\n hostId,\n email,\n ...(name ? { name } : {}),\n source: 'account',\n // The sentence the provenance carries is also the timeline row's: what\n // the person did, in the words an auditor reads.\n interaction: { atMs, summary: source.reason },\n ...(input.decision === 'granted'\n ? { marketingConsent: true }\n : { declineMarketingConsent: true }),\n marketingConsentSource: source,\n // An account on the platform is at least a lead for the platform's own\n // CRM, whichever way the marketing decision went; the floor never moves\n // a customer back.\n initialLifecycleStage: 'lead',\n })\n const contact: PlatformMarketingContactOutcome =\n 'refused' in verdict\n ? { status: 'refused', reason: verdict.refused }\n : { status: 'recorded', contactId: verdict.contactId, created: verdict.created }\n // Where the person came from (AGL-3519): an account sign-up, on a record\n // the platform's own CRM just started and that names no lead source.\n if (contact.status === 'recorded') {\n await stampRecordOrigin({ hostId, email, origin: 'account', firstTouchOnly: true })\n }\n if (input.decision !== 'granted') return { atMs, contact }\n\n /*\n * A Yes reopens the one list it stands for (AGL-3305).\n *\n * After the contact, whatever the contact's outcome: an erasure that\n * refused the row also left a suppression the plugin will not lift, and it\n * says so. One list wide, never \"resubscribe to everything\" — somebody who\n * left every list and now asks for product updates has asked for product\n * updates.\n */\n const stream: PlatformMarketingStreamOutcome = input.mailboxVerified\n ? await (input.rejoin ?? rejoinEmailStream)({\n hostId,\n email,\n topicId: PLATFORM_MARKETING_TOPIC_ID,\n })\n : { status: 'unverified' }\n return { atMs, contact, stream }\n}\n\n/**\n * Stamps a prompt dismissal — no decision — so the console stays quiet for\n * the snooze window and asks once more after it.\n */\nexport async function snoozePlatformMarketingPrompt(\n uid: string,\n options: { now?: number; firestore?: any } = {},\n): Promise<{ atMs: number }> {\n const trimmed = String(uid ?? '').trim()\n if (!trimmed) throw new Error('snoozePlatformMarketingPrompt: uid is required')\n const atMs = options.now ?? Date.now()\n await (options.firestore ?? firestore())\n .collection('users')\n .doc(trimmed)\n .set({ [USER_MARKETING_PROMPT_DISMISSED_AT_FIELD]: atMs }, { merge: true })\n return { atMs }\n}\n\n/** The decision the person's own document holds, for the console to show. */\nexport async function readPlatformMarketingConsentForUser(\n uid: string,\n options: { firestore?: any } = {},\n): Promise<PlatformMarketingConsentState> {\n const trimmed = String(uid ?? '').trim()\n if (!trimmed) throw new Error('readPlatformMarketingConsentForUser: uid is required')\n const snapshot = await (options.firestore ?? firestore())\n .collection('users')\n .doc(trimmed)\n .get()\n return readPlatformMarketingConsent(\n (snapshot?.data?.() as Record<string, unknown> | undefined) ?? null,\n )\n}\n\n/** An entry on one of the two lists every campaign send passes. */\nexport interface PlatformMarketingSuppression {\n /** `site`: the marketing site's own list. `platform`: every sender's. */\n list: 'site' | 'platform'\n /** `unsubscribe` on the site list; `bounce`, `complaint` or `staff` platform-wide. */\n reason: string\n}\n\n/**\n * What the operator's own product email would decide about one address\n * (AGL-3292), read the way a campaign from the marketing site reads it.\n *\n * The decision the person made lives on `users/{uid}`, and nothing a send\n * does looks there. A campaign from the configured marketing site reads the\n * CONTACT `recordPlatformMarketingConsent` wrote into that site's\n * organization — its basis for the site, under the organization's policy —\n * and then drops anybody on either suppression list, and a campaign on the\n * product-updates list anybody who left it. An unsubscribe writes those\n * lists; since AGL-3305 one about product updates also turns the account's\n * answer to No, but the contact's basis stays as it was, because it covers\n * every list the site sends. So a staff reader asking \"may we email them?\"\n * needs this half, and needs it from the sender's own readers — the same\n * basis read, consent group, policy and lists — or it answers a question no\n * send asks.\n */\nexport type PlatformMarketingReach =\n /** No marketing site is configured — a self-hosted install. */\n | { status: 'unconfigured' }\n /** The account carries no address a contact could be keyed on. */\n | { status: 'no-email' }\n /** A read failed. Nothing about the person follows from it. */\n | { status: 'unreadable'; hostId: string }\n | {\n status: 'read'\n hostId: string\n orgId: string\n orgSlug: string | null\n /** `null` when the operator's CRM holds no contact for the address. */\n contactId: string | null\n basis: MarketingBasis\n basisAtMs: number | null\n /** Whose act the basis is — a person's own, or an operator's assertion. */\n assertedBy: MarketingConsentAssertedBy | null\n /** Which door recorded the basis (`console-signup`, a form, a backfill). */\n basisKind: string | null\n /** The consent rule's answer alone, before either list is consulted. */\n verdict: MarketingConsentVerdict\n reason: MarketingConsentReason\n /** The list that stops every send to the address, when one does. */\n suppression: PlatformMarketingSuppression | null\n /**\n * The address on the list the account's answer stands for (AGL-3305):\n * `opted-out` when they left product updates, `pending` while a\n * confirmation is unanswered. A campaign on that list drops both.\n */\n topic: PlatformMarketingTopicState\n }\n\n/** One address on {@link PLATFORM_MARKETING_TOPIC_ID}, as the site stores it. */\nexport interface PlatformMarketingTopicState {\n id: string\n state: TopicSubscriptionState\n /** When they left it, for an `opted-out` state; else `null`. */\n leftAtMs: number | null\n}\n\n/**\n * The entry that suppresses `email` for sends from `hostId`, if any.\n *\n * The site's own list first, because it is the one a person puts themselves\n * on from this sender's footer; the platform list second. The same two reads\n * `filterSendableForHost` makes: a site entry suppresses by existing, and a\n * platform entry until it is released.\n */\nasync function readPlatformMarketingSuppression(\n db: any,\n hostId: string,\n email: string,\n): Promise<PlatformMarketingSuppression | null> {\n const key = emailSuppressionKey(email)\n if (!key) return null\n const [site, platform] = await Promise.all([\n db\n .collection('hosts')\n .doc(hostId)\n .collection(HOST_SUPPRESSIONS_SUBCOLLECTION)\n .doc(key)\n .get(),\n db.collection(EMAIL_SUPPRESSIONS_COLLECTION).doc(key).get(),\n ])\n if (site?.exists) {\n return { list: 'site', reason: String(site.get('reason') ?? 'unsubscribe') }\n }\n if (platform?.exists && !platform.get('releasedAt')) {\n return { list: 'platform', reason: String(platform.get('reason') ?? 'staff') }\n }\n return null\n}\n\n/** Milliseconds from a stored Firestore timestamp or a number, else `null`. */\nfunction storedMs(value: unknown): number | null {\n if (typeof value === 'number' && Number.isFinite(value)) return value\n const toMillis = (value as { toMillis?: () => number } | null)?.toMillis\n return typeof toMillis === 'function' ? toMillis.call(value) : null\n}\n\n/**\n * Where the address stands on {@link PLATFORM_MARKETING_TOPIC_ID}.\n *\n * The site's per-topic record, read by key and through the one function that\n * knows its three states — the same read `filterTopicSendable` makes before\n * a campaign on that list goes out. No record is `subscribed`: nobody has\n * left a list they were never taken off.\n */\nasync function readPlatformMarketingTopic(\n db: any,\n hostId: string,\n email: string,\n): Promise<PlatformMarketingTopicState> {\n const key = emailSuppressionKey(email)\n const unrecorded = { id: PLATFORM_MARKETING_TOPIC_ID, state: 'subscribed' as const, leftAtMs: null }\n if (!key) return unrecorded\n const snapshot = await db\n .collection('hosts')\n .doc(hostId)\n .collection(TOPIC_OPT_OUTS_SUBCOLLECTION)\n .doc(key)\n .get()\n if (!snapshot?.exists) return unrecorded\n const entry = ((snapshot.get('topics') ?? {}) as Record<string, TopicSubscriptionEntry | undefined>)[\n PLATFORM_MARKETING_TOPIC_ID\n ]\n const state = readTopicSubscriptionState(entry)\n return {\n id: PLATFORM_MARKETING_TOPIC_ID,\n state,\n leftAtMs: state === 'opted-out' ? storedMs(entry?.optedOutAt) : null,\n }\n}\n\n/**\n * Reads {@link PlatformMarketingReach} for an address.\n *\n * Never throws: a failed read is `unreadable`, which the staff page shows as\n * unknown — never as \"no consent\", which would be a claim about the person.\n */\nexport async function readPlatformMarketingReach(input: {\n email: string | null | undefined\n /** Injectable for tests; defaults to {@link platformMarketingHostId}. */\n hostId?: string | null\n /** Injectable for tests; defaults to the admin app's Firestore. */\n firestore?: any\n}): Promise<PlatformMarketingReach> {\n const hostId =\n input.hostId === undefined ? platformMarketingHostId() : input.hostId\n if (!hostId) return { status: 'unconfigured' }\n const email = String(input.email ?? '').trim().toLowerCase()\n if (!email) return { status: 'no-email' }\n const db = input.firestore ?? firestore()\n try {\n const owner = await getOrgForHost(hostId)\n if (!owner) return { status: 'unreadable', hostId }\n const org = owner.org as Record<string, unknown>\n const [person, group, suppression, topic] = await Promise.all([\n // The operator's person for the address, asked of the plugin that\n // keeps people (AGL-3080) — the record the capture door wrote.\n findPluginPerson({ orgId: owner.orgId, hostId, email }),\n consentGroupForSite(hostId, org),\n readPlatformMarketingSuppression(db, hostId, email),\n readPlatformMarketingTopic(db, hostId, email),\n ])\n const record = readMarketingBasis(person ? { ...person.data } : null, group)\n const decision = marketingConsentDecision(\n record,\n resolveMarketingConsentPolicy(org['marketingConsentPolicy']),\n )\n return {\n status: 'read',\n hostId,\n orgId: owner.orgId,\n orgSlug: typeof org['slug'] === 'string' ? org['slug'] : null,\n contactId: person?.id ?? null,\n basis: record.basis,\n basisAtMs: record.basisAtMs,\n assertedBy: record.assertedBy,\n basisKind: record.source?.kind ?? null,\n verdict: decision.verdict,\n reason: decision.reason,\n suppression,\n topic,\n }\n } catch (error) {\n console.error('[platform-marketing-consent] reach read failed', error)\n return { status: 'unreadable', hostId }\n }\n}\n\n/**\n * Why somebody who said Yes will not receive product updates, in the terms\n * of what they can do about it (AGL-3305) — or `null` when nothing on the\n * marketing site's lists stands in the way.\n *\n * - `unsubscribed`: they left everything, or left product updates, from an\n * email. Theirs to undo, and a Yes from a verified account does.\n * - `unconfirmed`: a confirmation for the list was asked and not answered.\n * - `paused`: a bounce, a complaint, an erasure or a staff hold. Not a\n * preference, so no switch of theirs lifts it.\n *\n * The consent basis is not judged here: the Yes this is asked about is the\n * basis. Only the lists a Yes cannot overrule are.\n */\nexport type PlatformMarketingHold =\n | { kind: 'unsubscribed' }\n | { kind: 'unconfirmed' }\n | { kind: 'paused'; reason: string }\n\nexport function platformMarketingHold(\n reach: PlatformMarketingReach,\n): PlatformMarketingHold | null {\n if (reach.status !== 'read') return null\n if (reach.suppression) {\n return reach.suppression.list === 'site' && reach.suppression.reason === 'unsubscribe'\n ? { kind: 'unsubscribed' }\n : { kind: 'paused', reason: reach.suppression.reason }\n }\n if (reach.topic.state === 'opted-out') return { kind: 'unsubscribed' }\n if (reach.topic.state === 'pending') return { kind: 'unconfirmed' }\n return null\n}\n\n/** What mirroring an email-side change onto the account did (AGL-3305). */\nexport type PlatformMarketingMirrorOutcome =\n /** Another site's list. An account is never touched from one. */\n | { status: 'not-platform' }\n /** A list the account's answer is not about. */\n | { status: 'other-list' }\n /** No account holds the address — or more than one does. */\n | { status: 'no-account' }\n /** The account already says so, or the rule leaves it where it is. */\n | { status: 'unchanged' }\n | { status: 'recorded'; uid: string; decision: PlatformMarketingConsentDecision }\n /** Logged; the site's own write, which is what stops the mail, stands. */\n | { status: 'failed' }\n\nexport interface PlatformMarketingMirrorInput {\n /** The site whose page the person used. */\n hostId: string\n /** The address the signed link was for. */\n email: string\n /** Injectable for tests; defaults to the clock. */\n now?: number\n /** Injectable for tests; defaults to the admin app's Firestore. */\n firestore?: any\n /** Injectable for tests; defaults to {@link platformMarketingHostId}. */\n platformHostId?: string | null\n /**\n * Injectable for tests; defaults to `attributableAccountForAddress`, which\n * answers `null` for nobody AND for more than one account. Changing the\n * wrong person's answer is worse than changing nobody's.\n */\n findAccount?: (email: string) => Promise<string | null>\n}\n\n/** The account a mirror would write, or the reason there is none. */\nasync function mirrorTarget(\n input: PlatformMarketingMirrorInput,\n): Promise<{ uid: string; ref: any; state: PlatformMarketingConsentState } | PlatformMarketingMirrorOutcome> {\n const platformHost =\n input.platformHostId === undefined ? platformMarketingHostId() : input.platformHostId\n if (!platformHost || input.hostId !== platformHost) return { status: 'not-platform' }\n const uid = await (input.findAccount ?? ((email: string) => attributableAccountForAddress(email)))(\n input.email,\n )\n if (!uid) return { status: 'no-account' }\n const ref = (input.firestore ?? firestore()).collection('users').doc(uid)\n const snapshot = await ref.get()\n return {\n uid,\n ref,\n state: readPlatformMarketingConsent(\n (snapshot?.data?.() as Record<string, unknown> | undefined) ?? null,\n ),\n }\n}\n\n/**\n * Mirrors an unsubscribe from the marketing site onto the account's answer.\n *\n * Called by the site's own pages AFTER their write, with what the person\n * left: `'everything'` for the site's list, or the topics left on the\n * preference page. Only the platform's marketing site counts, and only a\n * list the answer is about — {@link PLATFORM_MARKETING_TOPIC_ID}, which\n * everything includes. The first No keeps its date and its door: a second\n * unsubscribe is not a later decision.\n *\n * Never throws. The page has already stopped the mail; this is the account\n * catching up with it.\n */\nexport async function mirrorPlatformUnsubscribe(\n input: PlatformMarketingMirrorInput & { left: 'everything' | readonly string[] },\n): Promise<PlatformMarketingMirrorOutcome> {\n try {\n const everything = input.left === 'everything'\n if (!everything && !input.left.includes(PLATFORM_MARKETING_TOPIC_ID)) {\n // Cheaper to answer before the account lookup, and the answer does not\n // depend on the site: no other list is this one on any site.\n const platformHost =\n input.platformHostId === undefined ? platformMarketingHostId() : input.platformHostId\n return input.hostId === platformHost ? { status: 'other-list' } : { status: 'not-platform' }\n }\n const target = await mirrorTarget(input)\n if ('status' in target) return target\n if (target.state.decision === 'declined') return { status: 'unchanged' }\n const atMs = input.now ?? Date.now()\n const source = platformMarketingEmailSource(\n everything\n ? { kind: 'email-unsubscribe', decision: 'declined', uid: target.uid, atMs }\n : { kind: 'email-preferences', decision: 'declined', uid: target.uid, atMs },\n )\n await target.ref.set(\n platformMarketingUserFields({ decision: 'declined', atMs, source }),\n { merge: true },\n )\n return { status: 'recorded', uid: target.uid, decision: 'declined' }\n } catch (error) {\n console.error('[platform-marketing-consent] could not mirror an unsubscribe onto the account', error)\n return { status: 'failed' }\n }\n}\n\n/**\n * Mirrors a way back in from the marketing site: the resubscribe link, or\n * the list ticked again on the preference page.\n *\n * Narrower than the unsubscribe on purpose. It restores only a No that an\n * email door recorded — a No given in the console is the person's answer in\n * the console, and a link in an email does not overturn it — and only once\n * product updates would really reach them: nothing on either suppression\n * list, and the list itself not left. A resubscribe that lifted the site's\n * list while product updates stay unticked restores nothing.\n */\nexport async function mirrorPlatformResubscribe(\n input: PlatformMarketingMirrorInput & { via: 'email-resubscribe' | 'email-preferences' },\n): Promise<PlatformMarketingMirrorOutcome> {\n try {\n const target = await mirrorTarget(input)\n if ('status' in target) return target\n if (\n target.state.decision !== 'declined' ||\n !isPlatformMarketingEmailSourceKind(target.state.sourceKind)\n ) {\n return { status: 'unchanged' }\n }\n const db = input.firestore ?? firestore()\n const [suppression, topic] = await Promise.all([\n readPlatformMarketingSuppression(db, input.hostId, input.email),\n readPlatformMarketingTopic(db, input.hostId, input.email),\n ])\n if (suppression || topic.state !== 'subscribed') return { status: 'unchanged' }\n const atMs = input.now ?? Date.now()\n const source = platformMarketingEmailSource({\n kind: input.via,\n decision: 'granted',\n uid: target.uid,\n atMs,\n })\n await target.ref.set(\n platformMarketingUserFields({ decision: 'granted', atMs, source }),\n { merge: true },\n )\n return { status: 'recorded', uid: target.uid, decision: 'granted' }\n } catch (error) {\n console.error('[platform-marketing-consent] could not mirror a resubscribe onto the account', error)\n return { status: 'failed' }\n }\n}\n"],"names":["stampRecordOrigin","readTopicSubscriptionState","TOPIC_OPT_OUTS_SUBCOLLECTION","isPlatformMarketingConsentDecision","isPlatformMarketingConsoleSourceKind","isPlatformMarketingEmailSourceKind","platformMarketingConsentSource","platformMarketingEmailSource","PLATFORM_MARKETING_TOPIC_ID","platformMarketingUserFields","readPlatformMarketingConsent","USER_MARKETING_PROMPT_DISMISSED_AT_FIELD","marketingConsentDecision","readMarketingBasis","resolveMarketingConsentPolicy","rejoinEmailStream","attributableAccountForAddress","findPluginPerson","EMAIL_SUPPRESSIONS_COLLECTION","emailSuppressionKey","HOST_SUPPRESSIONS_SUBCOLLECTION","firebaseAdmin","consentGroupForSite","getOrgForHost","upsertHostContact","firestore","app","PLATFORM_MARKETING_HOST_ID_ENV","platformMarketingHostId","process","value","String","env","PLATFORM_MARKETING_HOST_ID","trim","accountName","snapshot","fallback","first","get","last","stored","filter","Boolean","join","undefined","recordPlatformMarketingConsent","input","uid","Error","decision","source","textVersion","atMs","now","Date","kind","userRef","collection","doc","set","merge","hostId","contact","status","email","name","verdict","upsert","interaction","summary","reason","marketingConsent","declineMarketingConsent","marketingConsentSource","initialLifecycleStage","refused","contactId","created","origin","firstTouchOnly","stream","mailboxVerified","rejoin","topicId","snoozePlatformMarketingPrompt","options","trimmed","readPlatformMarketingConsentForUser","data","readPlatformMarketingSuppression","db","key","site","platform","Promise","all","exists","list","storedMs","Number","isFinite","toMillis","call","readPlatformMarketingTopic","unrecorded","id","state","leftAtMs","entry","optedOutAt","readPlatformMarketingReach","toLowerCase","record","owner","org","person","group","suppression","topic","orgId","orgSlug","basis","basisAtMs","assertedBy","basisKind","error","console","platformMarketingHold","reach","mirrorTarget","platformHost","platformHostId","findAccount","ref","mirrorPlatformUnsubscribe","everything","left","includes","target","mirrorPlatformResubscribe","sourceKind","via"],"mappings":";AAAA;;;;;;;;;;;;;;;CAeC,GAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAgDC,GAED,SAASA,iBAAiB,QAAQ,mDAAkD;AACpF,SACEC,0BAA0B,EAC1BC,4BAA4B,QAGvB,6CAA4C;AACnD,SACEC,kCAAkC,EAClCC,oCAAoC,EACpCC,kCAAkC,EAIlCC,8BAA8B,EAC9BC,4BAA4B,EAC5BC,2BAA2B,EAC3BC,2BAA2B,EAC3BC,4BAA4B,EAC5BC,wCAAwC,QACnC,oDAAmD;AAC1D,SACEC,wBAAwB,EAKxBC,kBAAkB,EAClBC,6BAA6B,QACxB,2CAA0C;AACjD,SAEEC,iBAAiB,QACZ,mDAAkD;AACzD,SAASC,6BAA6B,QAAQ,yBAAqB;AACnE,SAASC,gBAAgB,QAAQ,oDAAmD;AACpF,SACEC,6BAA6B,EAC7BC,mBAAmB,EACnBC,+BAA+B,QAC1B,yBAAqB;AAC5B,OAAOC,mBAAmB,sBAAkB;AAC5C,SAASC,mBAAmB,EAAEC,aAAa,QAAQ,qBAAiB;AACpE,SAASC,iBAAiB,QAAQ,sBAAkB;AAEpD,MAAMC,YAAY,IAAMJ,cAAcK,GAAG,GAAGD,SAAS;AAErD;;;;CAIC,GACD,OAAO,MAAME,iCAAiC,6BAA4B;AAE1E;;;;;;CAMC,GACD,OAAO,SAASC;QACOC;IAArB,MAAMC,QAAQC,QAAOF,0CAAAA,QAAQG,GAAG,CAACC,0BAA0B,YAAtCJ,0CAA0C,IAAIK,IAAI;IACvE,OAAOJ,SAAS;AAClB;AA0DA;;;;;;CAMC,GACD,SAASK,YACPC,QAAiE,EACjEC,QAAmC;;QAEdD,eACDA;IADpB,MAAME,QAAQP,eAAOK,6BAAAA,gBAAAA,SAAUG,GAAG,qBAAbH,mBAAAA,UAAgB,+BAAgB,IAAIF,IAAI;IAC7D,MAAMM,OAAOT,gBAAOK,6BAAAA,iBAAAA,SAAUG,GAAG,qBAAbH,oBAAAA,UAAgB,+BAAe,IAAIF,IAAI;IAC3D,MAAMO,SAAS;QAACH;QAAOE;KAAK,CAACE,MAAM,CAACC,SAASC,IAAI,CAAC;IAClD,OAAOH,UAAUV,OAAOM,mBAAAA,WAAY,IAAIH,IAAI,MAAMW;AACpD;AAEA;;;;;;;;CAQC,GACD,OAAO,eAAeC,+BACpBC,KAA0C;QAEvBA,YAQQA,oBAKdA,YASIA,kBAUIA,cAIEA,eAsCZA;IA1EX,MAAMC,MAAMjB,QAAOgB,aAAAA,MAAMC,GAAG,YAATD,aAAa,IAAIb,IAAI;IACxC,IAAI,CAACc,KAAK,MAAM,IAAIC,MAAM;IAC1B,IAAI,CAAC9C,mCAAmC4C,MAAMG,QAAQ,GAAG;QACvD,MAAM,IAAID,MAAM;IAClB;IACA,IAAI,CAAC7C,qCAAqC2C,MAAMI,MAAM,GAAG;QACvD,MAAM,IAAIF,MAAM;IAClB;IACA,MAAMG,cAAcrB,QAAOgB,qBAAAA,MAAMK,WAAW,YAAjBL,qBAAqB,IAAIb,IAAI;IACxD,IAAI,CAACkB,aAAa;QAChB,MAAM,IAAIH,MAAM;IAClB;IAEA,MAAMI,QAAON,aAAAA,MAAMO,GAAG,YAATP,aAAaQ,KAAKD,GAAG;IAClC,MAAMH,SAAS7C,+BAA+B;QAC5CkD,MAAMT,MAAMI,MAAM;QAClBD,UAAUH,MAAMG,QAAQ;QACxBF;QACAK;QACAD;IACF;IAEA,MAAMK,UAAU,EAACV,mBAAAA,MAAMtB,SAAS,YAAfsB,mBAAmBtB,aAAaiC,UAAU,CAAC,SAASC,GAAG,CAACX;IACzE,MAAMZ,WAAW,MAAMqB,QAAQlB,GAAG;IAClC,MAAMkB,QAAQG,GAAG,CACfnD,4BAA4B;QAAEyC,UAAUH,MAAMG,QAAQ;QAAEG;QAAMF;IAAO,IACrE;QAAEU,OAAO;IAAK;IAGhB,MAAMC,SACJf,MAAMe,MAAM,KAAKjB,YAAYjB,4BAA4BmB,MAAMe,MAAM;IACvE,IAAI,CAACA,QAAQ,OAAO;QAAET;QAAMU,SAAS;YAAEC,QAAQ;QAAe;IAAE;IAChE,MAAMC,QAAQlC,QAAOgB,eAAAA,MAAMkB,KAAK,YAAXlB,eAAe,IAAIb,IAAI;IAC5C,IAAI,CAAC+B,OAAO,OAAO;QAAEZ;QAAMU,SAAS;YAAEC,QAAQ;QAAW;IAAE;IAE3D,MAAME,OAAO/B,YAAYC,UAAUW,MAAMmB,IAAI;IAC7C,MAAMC,UAAU,MAAM,EAACpB,gBAAAA,MAAMqB,MAAM,YAAZrB,gBAAgBvB,mBAAmB;QACxDsC;QACAG;OACIC,OAAO;QAAEA;IAAK,IAAI,CAAC;QACvBf,QAAQ;QACR,uEAAuE;QACvE,iDAAiD;QACjDkB,aAAa;YAAEhB;YAAMiB,SAASnB,OAAOoB,MAAM;QAAC;OACxCxB,MAAMG,QAAQ,KAAK,YACnB;QAAEsB,kBAAkB;IAAK,IACzB;QAAEC,yBAAyB;IAAK;QACpCC,wBAAwBvB;QACxB,uEAAuE;QACvE,wEAAwE;QACxE,mBAAmB;QACnBwB,uBAAuB;;IAEzB,MAAMZ,UACJ,aAAaI,UACT;QAAEH,QAAQ;QAAWO,QAAQJ,QAAQS,OAAO;IAAC,IAC7C;QAAEZ,QAAQ;QAAYa,WAAWV,QAAQU,SAAS;QAAEC,SAASX,QAAQW,OAAO;IAAC;IACnF,yEAAyE;IACzE,qEAAqE;IACrE,IAAIf,QAAQC,MAAM,KAAK,YAAY;QACjC,MAAMhE,kBAAkB;YAAE8D;YAAQG;YAAOc,QAAQ;YAAWC,gBAAgB;QAAK;IACnF;IACA,IAAIjC,MAAMG,QAAQ,KAAK,WAAW,OAAO;QAAEG;QAAMU;IAAQ;IAEzD;;;;;;;;GAQC,GACD,MAAMkB,SAAyClC,MAAMmC,eAAe,GAChE,MAAM,EAACnC,gBAAAA,MAAMoC,MAAM,YAAZpC,gBAAgBhC,mBAAmB;QACxC+C;QACAG;QACAmB,SAAS5E;IACX,KACA;QAAEwD,QAAQ;IAAa;IAC3B,OAAO;QAAEX;QAAMU;QAASkB;IAAO;AACjC;AAEA;;;CAGC,GACD,OAAO,eAAeI,8BACpBrC,GAAW,EACXsC,UAA6C,CAAC,CAAC;QAIlCA,cACNA;IAHP,MAAMC,UAAUxD,OAAOiB,cAAAA,MAAO,IAAId,IAAI;IACtC,IAAI,CAACqD,SAAS,MAAM,IAAItC,MAAM;IAC9B,MAAMI,QAAOiC,eAAAA,QAAQhC,GAAG,YAAXgC,eAAe/B,KAAKD,GAAG;IACpC,MAAM,EAACgC,qBAAAA,QAAQ7D,SAAS,YAAjB6D,qBAAqB7D,aACzBiC,UAAU,CAAC,SACXC,GAAG,CAAC4B,SACJ3B,GAAG,CAAC;QAAE,CAACjD,yCAAyC,EAAE0C;IAAK,GAAG;QAAEQ,OAAO;IAAK;IAC3E,OAAO;QAAER;IAAK;AAChB;AAEA,2EAA2E,GAC3E,OAAO,eAAemC,oCACpBxC,GAAW,EACXsC,UAA+B,CAAC,CAAC;QAITA;QAKrBlD;IAPH,MAAMmD,UAAUxD,OAAOiB,cAAAA,MAAO,IAAId,IAAI;IACtC,IAAI,CAACqD,SAAS,MAAM,IAAItC,MAAM;IAC9B,MAAMb,WAAW,MAAM,EAACkD,qBAAAA,QAAQ7D,SAAS,YAAjB6D,qBAAqB7D,aAC1CiC,UAAU,CAAC,SACXC,GAAG,CAAC4B,SACJhD,GAAG;IACN,OAAO7B,qCACJ0B,6BAAAA,iBAAAA,SAAUqD,IAAI,qBAAdrD,oBAAAA,4BAA8D;AAEnE;AAoEA;;;;;;;CAOC,GACD,eAAesD,iCACbC,EAAO,EACP7B,MAAc,EACdG,KAAa;IAEb,MAAM2B,MAAMzE,oBAAoB8C;IAChC,IAAI,CAAC2B,KAAK,OAAO;IACjB,MAAM,CAACC,MAAMC,SAAS,GAAG,MAAMC,QAAQC,GAAG,CAAC;QACzCL,GACGjC,UAAU,CAAC,SACXC,GAAG,CAACG,QACJJ,UAAU,CAACtC,iCACXuC,GAAG,CAACiC,KACJrD,GAAG;QACNoD,GAAGjC,UAAU,CAACxC,+BAA+ByC,GAAG,CAACiC,KAAKrD,GAAG;KAC1D;IACD,IAAIsD,wBAAAA,KAAMI,MAAM,EAAE;YACsBJ;QAAtC,OAAO;YAAEK,MAAM;YAAQ3B,QAAQxC,QAAO8D,YAAAA,KAAKtD,GAAG,CAAC,qBAATsD,YAAsB;QAAe;IAC7E;IACA,IAAIC,CAAAA,4BAAAA,SAAUG,MAAM,KAAI,CAACH,SAASvD,GAAG,CAAC,eAAe;YACTuD;QAA1C,OAAO;YAAEI,MAAM;YAAY3B,QAAQxC,QAAO+D,gBAAAA,SAASvD,GAAG,CAAC,qBAAbuD,gBAA0B;QAAS;IAC/E;IACA,OAAO;AACT;AAEA,6EAA6E,GAC7E,SAASK,SAASrE,KAAc;IAC9B,IAAI,OAAOA,UAAU,YAAYsE,OAAOC,QAAQ,CAACvE,QAAQ,OAAOA;IAChE,MAAMwE,WAAYxE,yBAAD,AAACA,MAA8CwE,QAAQ;IACxE,OAAO,OAAOA,aAAa,aAAaA,SAASC,IAAI,CAACzE,SAAS;AACjE;AAEA;;;;;;;CAOC,GACD,eAAe0E,2BACbb,EAAO,EACP7B,MAAc,EACdG,KAAa;QAYG7B;IAVhB,MAAMwD,MAAMzE,oBAAoB8C;IAChC,MAAMwC,aAAa;QAAEC,IAAIlG;QAA6BmG,OAAO;QAAuBC,UAAU;IAAK;IACnG,IAAI,CAAChB,KAAK,OAAOa;IACjB,MAAMrE,WAAW,MAAMuD,GACpBjC,UAAU,CAAC,SACXC,GAAG,CAACG,QACJJ,UAAU,CAACxD,8BACXyD,GAAG,CAACiC,KACJrD,GAAG;IACN,IAAI,EAACH,4BAAAA,SAAU6D,MAAM,GAAE,OAAOQ;IAC9B,MAAMI,QAAQ,EAAEzE,gBAAAA,SAASG,GAAG,CAAC,qBAAbH,gBAA0B,CAAC,EAAyD,CAClG5B,4BACD;IACD,MAAMmG,QAAQ1G,2BAA2B4G;IACzC,OAAO;QACLH,IAAIlG;QACJmG;QACAC,UAAUD,UAAU,cAAcR,SAASU,yBAAAA,MAAOC,UAAU,IAAI;IAClE;AACF;AAEA;;;;;CAKC,GACD,OAAO,eAAeC,2BAA2BhE,KAMhD;QAIsBA,cAEVA;IALX,MAAMe,SACJf,MAAMe,MAAM,KAAKjB,YAAYjB,4BAA4BmB,MAAMe,MAAM;IACvE,IAAI,CAACA,QAAQ,OAAO;QAAEE,QAAQ;IAAe;IAC7C,MAAMC,QAAQlC,QAAOgB,eAAAA,MAAMkB,KAAK,YAAXlB,eAAe,IAAIb,IAAI,GAAG8E,WAAW;IAC1D,IAAI,CAAC/C,OAAO,OAAO;QAAED,QAAQ;IAAW;IACxC,MAAM2B,MAAK5C,mBAAAA,MAAMtB,SAAS,YAAfsB,mBAAmBtB;IAC9B,IAAI;;YA0BWwF;QAzBb,MAAMC,QAAQ,MAAM3F,cAAcuC;QAClC,IAAI,CAACoD,OAAO,OAAO;YAAElD,QAAQ;YAAcF;QAAO;QAClD,MAAMqD,MAAMD,MAAMC,GAAG;QACrB,MAAM,CAACC,QAAQC,OAAOC,aAAaC,MAAM,GAAG,MAAMxB,QAAQC,GAAG,CAAC;YAC5D,kEAAkE;YAClE,+DAA+D;YAC/D/E,iBAAiB;gBAAEuG,OAAON,MAAMM,KAAK;gBAAE1D;gBAAQG;YAAM;YACrD3C,oBAAoBwC,QAAQqD;YAC5BzB,iCAAiCC,IAAI7B,QAAQG;YAC7CuC,2BAA2Bb,IAAI7B,QAAQG;SACxC;QACD,MAAMgD,SAASpG,mBAAmBuG,SAAS,aAAKA,OAAO3B,IAAI,IAAK,MAAM4B;QACtE,MAAMnE,WAAWtC,yBACfqG,QACAnG,8BAA8BqG,GAAG,CAAC,yBAAyB;QAE7D,OAAO;YACLnD,QAAQ;YACRF;YACA0D,OAAON,MAAMM,KAAK;YAClBC,SAAS,OAAON,GAAG,CAAC,OAAO,KAAK,WAAWA,GAAG,CAAC,OAAO,GAAG;YACzDtC,SAAS,UAAEuC,0BAAAA,OAAQV,EAAE,mBAAI;YACzBgB,OAAOT,OAAOS,KAAK;YACnBC,WAAWV,OAAOU,SAAS;YAC3BC,YAAYX,OAAOW,UAAU;YAC7BC,SAAS,YAAEZ,iBAAAA,OAAO9D,MAAM,qBAAb8D,eAAezD,IAAI,oBAAI;YAClCW,SAASjB,SAASiB,OAAO;YACzBI,QAAQrB,SAASqB,MAAM;YACvB+C;YACAC;QACF;IACF,EAAE,OAAOO,OAAO;QACdC,QAAQD,KAAK,CAAC,kDAAkDA;QAChE,OAAO;YAAE9D,QAAQ;YAAcF;QAAO;IACxC;AACF;AAqBA,OAAO,SAASkE,sBACdC,KAA6B;IAE7B,IAAIA,MAAMjE,MAAM,KAAK,QAAQ,OAAO;IACpC,IAAIiE,MAAMX,WAAW,EAAE;QACrB,OAAOW,MAAMX,WAAW,CAACpB,IAAI,KAAK,UAAU+B,MAAMX,WAAW,CAAC/C,MAAM,KAAK,gBACrE;YAAEf,MAAM;QAAe,IACvB;YAAEA,MAAM;YAAUe,QAAQ0D,MAAMX,WAAW,CAAC/C,MAAM;QAAC;IACzD;IACA,IAAI0D,MAAMV,KAAK,CAACZ,KAAK,KAAK,aAAa,OAAO;QAAEnD,MAAM;IAAe;IACrE,IAAIyE,MAAMV,KAAK,CAACZ,KAAK,KAAK,WAAW,OAAO;QAAEnD,MAAM;IAAc;IAClE,OAAO;AACT;AAmCA,mEAAmE,GACnE,eAAe0E,aACbnF,KAAmC;QAKhBA,oBAINA;QAMRX;IAbL,MAAM+F,eACJpF,MAAMqF,cAAc,KAAKvF,YAAYjB,4BAA4BmB,MAAMqF,cAAc;IACvF,IAAI,CAACD,gBAAgBpF,MAAMe,MAAM,KAAKqE,cAAc,OAAO;QAAEnE,QAAQ;IAAe;IACpF,MAAMhB,MAAM,MAAM,EAACD,qBAAAA,MAAMsF,WAAW,YAAjBtF,qBAAsB,CAACkB,QAAkBjD,8BAA8BiD,QACxFlB,MAAMkB,KAAK;IAEb,IAAI,CAACjB,KAAK,OAAO;QAAEgB,QAAQ;IAAa;IACxC,MAAMsE,MAAM,EAACvF,mBAAAA,MAAMtB,SAAS,YAAfsB,mBAAmBtB,aAAaiC,UAAU,CAAC,SAASC,GAAG,CAACX;IACrE,MAAMZ,WAAW,MAAMkG,IAAI/F,GAAG;IAC9B,OAAO;QACLS;QACAsF;QACA3B,OAAOjG,qCACJ0B,6BAAAA,iBAAAA,SAAUqD,IAAI,qBAAdrD,oBAAAA,4BAA8D;IAEnE;AACF;AAEA;;;;;;;;;;;;CAYC,GACD,OAAO,eAAemG,0BACpBxF,KAAgF;IAEhF,IAAI;YAYWA;QAXb,MAAMyF,aAAazF,MAAM0F,IAAI,KAAK;QAClC,IAAI,CAACD,cAAc,CAACzF,MAAM0F,IAAI,CAACC,QAAQ,CAAClI,8BAA8B;YACpE,uEAAuE;YACvE,6DAA6D;YAC7D,MAAM2H,eACJpF,MAAMqF,cAAc,KAAKvF,YAAYjB,4BAA4BmB,MAAMqF,cAAc;YACvF,OAAOrF,MAAMe,MAAM,KAAKqE,eAAe;gBAAEnE,QAAQ;YAAa,IAAI;gBAAEA,QAAQ;YAAe;QAC7F;QACA,MAAM2E,SAAS,MAAMT,aAAanF;QAClC,IAAI,YAAY4F,QAAQ,OAAOA;QAC/B,IAAIA,OAAOhC,KAAK,CAACzD,QAAQ,KAAK,YAAY,OAAO;YAAEc,QAAQ;QAAY;QACvE,MAAMX,QAAON,aAAAA,MAAMO,GAAG,YAATP,aAAaQ,KAAKD,GAAG;QAClC,MAAMH,SAAS5C,6BACbiI,aACI;YAAEhF,MAAM;YAAqBN,UAAU;YAAYF,KAAK2F,OAAO3F,GAAG;YAAEK;QAAK,IACzE;YAAEG,MAAM;YAAqBN,UAAU;YAAYF,KAAK2F,OAAO3F,GAAG;YAAEK;QAAK;QAE/E,MAAMsF,OAAOL,GAAG,CAAC1E,GAAG,CAClBnD,4BAA4B;YAAEyC,UAAU;YAAYG;YAAMF;QAAO,IACjE;YAAEU,OAAO;QAAK;QAEhB,OAAO;YAAEG,QAAQ;YAAYhB,KAAK2F,OAAO3F,GAAG;YAAEE,UAAU;QAAW;IACrE,EAAE,OAAO4E,OAAO;QACdC,QAAQD,KAAK,CAAC,iFAAiFA;QAC/F,OAAO;YAAE9D,QAAQ;QAAS;IAC5B;AACF;AAEA;;;;;;;;;;CAUC,GACD,OAAO,eAAe4E,0BACpB7F,KAAwF;IAExF,IAAI;YASSA,kBAMEA;QAdb,MAAM4F,SAAS,MAAMT,aAAanF;QAClC,IAAI,YAAY4F,QAAQ,OAAOA;QAC/B,IACEA,OAAOhC,KAAK,CAACzD,QAAQ,KAAK,cAC1B,CAAC7C,mCAAmCsI,OAAOhC,KAAK,CAACkC,UAAU,GAC3D;YACA,OAAO;gBAAE7E,QAAQ;YAAY;QAC/B;QACA,MAAM2B,MAAK5C,mBAAAA,MAAMtB,SAAS,YAAfsB,mBAAmBtB;QAC9B,MAAM,CAAC6F,aAAaC,MAAM,GAAG,MAAMxB,QAAQC,GAAG,CAAC;YAC7CN,iCAAiCC,IAAI5C,MAAMe,MAAM,EAAEf,MAAMkB,KAAK;YAC9DuC,2BAA2Bb,IAAI5C,MAAMe,MAAM,EAAEf,MAAMkB,KAAK;SACzD;QACD,IAAIqD,eAAeC,MAAMZ,KAAK,KAAK,cAAc,OAAO;YAAE3C,QAAQ;QAAY;QAC9E,MAAMX,QAAON,aAAAA,MAAMO,GAAG,YAATP,aAAaQ,KAAKD,GAAG;QAClC,MAAMH,SAAS5C,6BAA6B;YAC1CiD,MAAMT,MAAM+F,GAAG;YACf5F,UAAU;YACVF,KAAK2F,OAAO3F,GAAG;YACfK;QACF;QACA,MAAMsF,OAAOL,GAAG,CAAC1E,GAAG,CAClBnD,4BAA4B;YAAEyC,UAAU;YAAWG;YAAMF;QAAO,IAChE;YAAEU,OAAO;QAAK;QAEhB,OAAO;YAAEG,QAAQ;YAAYhB,KAAK2F,OAAO3F,GAAG;YAAEE,UAAU;QAAU;IACpE,EAAE,OAAO4E,OAAO;QACdC,QAAQD,KAAK,CAAC,gFAAgFA;QAC9F,OAAO;YAAE9D,QAAQ;QAAS;IAC5B;AACF"}
|
|
1
|
+
{"version":3,"sources":["../../../../../../../../libs/tenant/data/admin/src/lib/server/platform-marketing-consent.ts"],"sourcesContent":["/**\n * @license\n * Copyright 2026 Aglyn LLC\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n/**\n * The record a console door writes when a person decides about the\n * platform's own product email (AGL-3185).\n *\n * ## Two documents, one decision\n *\n * The decision goes onto the person's own `users/{uid}` first — the console\n * shows the preference from there, and it must not depend on the operator's\n * CRM accepting a row — and then onto the operator's marketing contact for\n * the same address through `upsertHostContact`, which is every other capture\n * door's path and the only one the send-time consent join reads. The contact\n * half carries the decision AND its provenance, so a campaign's audience\n * count reports this basis as the person's own click and never as something\n * asserted on their behalf.\n *\n * ## Server-side, because the client cannot and should not\n *\n * The sign-up page is a client of the person's own project; the operator's\n * marketing org is somebody else's data. Only the Admin SDK writes there, and\n * only after the person's ID token has been verified by the route in front\n * of this module. The user-document half could be a client write — the rules\n * make it owner-writable — but a mirror the client writes and the server\n * reads back is two writers of one fact, so both halves are written here.\n *\n * ## Which host, and why it is a setting\n *\n * The marketing host is the deployment's, not the code's: this repository is\n * what a self-hosted install runs, and an install with no product audience of\n * its own has nowhere for a contact to go. `PLATFORM_MARKETING_HOST_ID` names\n * it, and when it is unset the decision is recorded on the person's document\n * alone. No hostname or document id is hardcoded here for the same reason\n * `platform-marketing-host.ts` gives: nothing in the code knows which site\n * is the operator's.\n *\n * ## The site's own pages answer the same question, for one list (AGL-3305)\n *\n * The marketing site's emails carry their own way out, and it writes the\n * site's lists, not either consent record. An unsubscribe that was about the\n * list the console's question stands for — `PLATFORM_MARKETING_TOPIC_ID`, or\n * everything the site sends — is mirrored onto the ACCOUNT here, through an\n * email door; an unsubscribe from any other list is not, because the person\n * said nothing about product updates. The contact is left alone on purpose:\n * its basis covers every list the site sends, and declining it would stop the\n * newsletter for somebody who only left product updates.\n *\n * The console's switch undoes it the same way, one list wide: a Yes from a\n * verified account asks the plugin that keeps the site's preferences to\n * reopen that list and nothing else (`plugin-email-streams`).\n */\n\nimport { stampRecordOrigin } from '@aglyn/aglyn/plugin-manager/plugin-record-origin'\nimport {\n readTopicSubscriptionState,\n TOPIC_OPT_OUTS_SUBCOLLECTION,\n type TopicSubscriptionEntry,\n type TopicSubscriptionState,\n} from '@aglyn/aglyn/app-utils/subscription-topics'\nimport {\n isPlatformMarketingConsentDecision,\n isPlatformMarketingConsoleSourceKind,\n isPlatformMarketingEmailSourceKind,\n type PlatformMarketingConsentDecision,\n type PlatformMarketingConsoleSourceKind,\n type PlatformMarketingConsentState,\n platformMarketingConsentSource,\n platformMarketingEmailSource,\n PLATFORM_MARKETING_TOPIC_ID,\n platformMarketingUserFields,\n readPlatformMarketingConsent,\n USER_MARKETING_PROMPT_DISMISSED_AT_FIELD,\n} from '@aglyn/aglyn/app-utils/platform-marketing-consent'\nimport {\n marketingConsentDecision,\n type MarketingBasis,\n type MarketingConsentAssertedBy,\n type MarketingConsentReason,\n type MarketingConsentVerdict,\n readMarketingBasis,\n resolveMarketingConsentPolicy,\n} from '@aglyn/aglyn/app-utils/marketing-consent'\nimport {\n type EmailStreamRejoinOutcome,\n rejoinEmailStream,\n} from '@aglyn/aglyn/plugin-manager/plugin-email-streams'\nimport { attributableAccountForAddress } from './account-addresses'\nimport { findPluginPerson } from '@aglyn/aglyn/plugin-manager/plugin-person-records'\nimport {\n EMAIL_SUPPRESSIONS_COLLECTION,\n emailSuppressionKey,\n HOST_SUPPRESSIONS_SUBCOLLECTION,\n} from './email-suppression'\nimport firebaseAdmin from './firebase-admin'\nimport { consentGroupForSite, getOrgForHost } from './organizations'\nimport { upsertHostContact } from './upsert-contact'\n\nconst firestore = () => firebaseAdmin.app().firestore()\n\n/**\n * The variable naming the host whose contacts receive product-marketing\n * consent — the operator's own marketing site. Unset on a self-hosted\n * install, and honored as \"record the preference, capture no contact\".\n */\nexport const PLATFORM_MARKETING_HOST_ID_ENV = 'PLATFORM_MARKETING_HOST_ID'\n\n/**\n * The configured marketing host, or `null` when the deployment names none.\n *\n * Read at call time rather than at module load, so a test can set it and a\n * process that started without it picks up a later value the same way every\n * other runtime setting here does.\n */\nexport function platformMarketingHostId(): string | null {\n const value = String(process.env.PLATFORM_MARKETING_HOST_ID ?? '').trim()\n return value || null\n}\n\n/** What became of the contact half of the record. */\nexport type PlatformMarketingContactOutcome =\n | { status: 'recorded'; contactId: string; created: boolean }\n /** No marketing host is configured — a self-hosted install. */\n | { status: 'unconfigured' }\n /** The account carries no address a contact could be keyed on. */\n | { status: 'no-email' }\n /** The capture door refused the row — its band, an erasure, or an error. */\n | { status: 'refused'; reason: string }\n\nexport interface RecordPlatformMarketingConsentInput {\n uid: string\n /** The account's address, from the verified token. */\n email: string | null | undefined\n /** The name the token carries, for an account whose document holds none. */\n name?: string | null\n decision: PlatformMarketingConsentDecision\n /** A console door. An email door is recorded by the site's own pages. */\n source: PlatformMarketingConsoleSourceKind\n /** The wording version the door showed, stamped by the route. */\n textVersion: string\n /**\n * Whether the token proves the caller holds the mailbox — its email is\n * verified (AGL-3305). Only then does a Yes reopen the list on the\n * marketing site, because reopening it reverses what somebody did from\n * that mailbox; an unverified account could name a stranger's address.\n */\n mailboxVerified?: boolean\n /** Injectable for tests; defaults to the clock. */\n now?: number\n /** Injectable for tests; defaults to the admin app's Firestore. */\n firestore?: any\n /** Injectable for tests; defaults to {@link platformMarketingHostId}. */\n hostId?: string | null\n /** Injectable for tests; defaults to the real capture door. */\n upsert?: typeof upsertHostContact\n /** Injectable for tests; defaults to the `plugin-email-streams` slot. */\n rejoin?: typeof rejoinEmailStream\n}\n\n/**\n * What a Yes did to the marketing site's own lists (AGL-3305). Absent for a\n * No, and whenever there is no site or no address to reopen a list for.\n */\nexport type PlatformMarketingStreamOutcome =\n | EmailStreamRejoinOutcome\n /** The token does not prove the mailbox, so nothing was reopened. */\n | { status: 'unverified' }\n\nexport interface RecordPlatformMarketingConsentResult {\n /** The timestamp both documents carry. */\n atMs: number\n contact: PlatformMarketingContactOutcome\n stream?: PlatformMarketingStreamOutcome\n}\n\n/**\n * The name the person's own document holds, else the one the caller has.\n *\n * The sign-up form writes `firstName`/`lastName` onto the document; a Google\n * account carries its name on the token instead. Either is the name the\n * contact row should show, and a blank is left blank rather than invented.\n */\nfunction accountName(\n snapshot: { get?: (field: string) => unknown } | null | undefined,\n fallback: string | null | undefined,\n): string | undefined {\n const first = String(snapshot?.get?.('firstName') ?? '').trim()\n const last = String(snapshot?.get?.('lastName') ?? '').trim()\n const stored = [first, last].filter(Boolean).join(' ')\n return stored || String(fallback ?? '').trim() || undefined\n}\n\n/**\n * Records a decision on both documents.\n *\n * Loud on bad input, like `recordLegalAcceptance`: a decision that cannot be\n * attributed to an account, a door and a wording is not a record of anything.\n * Quiet on the contact half — a refused row is returned, not thrown — because\n * the person's own preference has already been recorded by then, and the\n * operator's CRM band is not a reason to tell them their choice failed.\n */\nexport async function recordPlatformMarketingConsent(\n input: RecordPlatformMarketingConsentInput,\n): Promise<RecordPlatformMarketingConsentResult> {\n const uid = String(input.uid ?? '').trim()\n if (!uid) throw new Error('recordPlatformMarketingConsent: uid is required')\n if (!isPlatformMarketingConsentDecision(input.decision)) {\n throw new Error('recordPlatformMarketingConsent: decision is required')\n }\n if (!isPlatformMarketingConsoleSourceKind(input.source)) {\n throw new Error('recordPlatformMarketingConsent: a console source is required')\n }\n const textVersion = String(input.textVersion ?? '').trim()\n if (!textVersion) {\n throw new Error('recordPlatformMarketingConsent: textVersion is required')\n }\n\n const atMs = input.now ?? Date.now()\n const source = platformMarketingConsentSource({\n kind: input.source,\n decision: input.decision,\n uid,\n atMs,\n textVersion,\n })\n\n const userRef = (input.firestore ?? firestore()).collection('users').doc(uid)\n const snapshot = await userRef.get()\n await userRef.set(\n platformMarketingUserFields({ decision: input.decision, atMs, source }),\n { merge: true },\n )\n\n const hostId =\n input.hostId === undefined ? platformMarketingHostId() : input.hostId\n if (!hostId) return { atMs, contact: { status: 'unconfigured' } }\n const email = String(input.email ?? '').trim()\n if (!email) return { atMs, contact: { status: 'no-email' } }\n\n const name = accountName(snapshot, input.name)\n const verdict = await (input.upsert ?? upsertHostContact)({\n hostId,\n email,\n ...(name ? { name } : {}),\n source: 'account',\n // The sentence the provenance carries is also the timeline row's: what\n // the person did, in the words an auditor reads.\n interaction: { atMs, summary: source.reason },\n ...(input.decision === 'granted'\n ? { marketingConsent: true }\n : { declineMarketingConsent: true }),\n marketingConsentSource: source,\n // An account on the platform is at least a lead for the platform's own\n // CRM, whichever way the marketing decision went; the floor never moves\n // a customer back.\n initialLifecycleStage: 'lead',\n })\n const contact: PlatformMarketingContactOutcome =\n 'refused' in verdict\n ? { status: 'refused', reason: verdict.refused }\n : { status: 'recorded', contactId: verdict.contactId, created: verdict.created }\n // Where the person came from (AGL-3519): an account sign-up, on a record\n // the platform's own CRM just started and that names no lead source.\n if (contact.status === 'recorded') {\n await stampRecordOrigin({ hostId, email, origin: 'account', firstTouchOnly: true })\n }\n if (input.decision !== 'granted') return { atMs, contact }\n\n /*\n * A Yes reopens the one list it stands for (AGL-3305).\n *\n * After the contact, whatever the contact's outcome: an erasure that\n * refused the row also left a suppression the plugin will not lift, and it\n * says so. One list wide, never \"resubscribe to everything\" — somebody who\n * left every list and now asks for product updates has asked for product\n * updates.\n */\n const stream: PlatformMarketingStreamOutcome = input.mailboxVerified\n ? await (input.rejoin ?? rejoinEmailStream)({\n hostId,\n email,\n topicId: PLATFORM_MARKETING_TOPIC_ID,\n })\n : { status: 'unverified' }\n return { atMs, contact, stream }\n}\n\n/** The timeline row an account's own contact opens with. */\nexport const PLATFORM_ACCOUNT_CREATED_SUMMARY = 'Created an account'\n\nexport interface RecordPlatformAccountContactInput {\n uid: string\n /** The account's address, from the verified token or the auth record. */\n email: string | null | undefined\n /** The name the token or auth record carries, for an account whose document holds none. */\n name?: string | null\n /** When the account was created, which is when its timeline row happened. */\n createdAtMs: number\n /** Injectable for tests; defaults to the admin app's Firestore. */\n firestore?: any\n /** Injectable for tests; defaults to {@link platformMarketingHostId}. */\n hostId?: string | null\n /** Injectable for tests; defaults to the real capture door. */\n upsert?: typeof upsertHostContact\n}\n\n/**\n * Makes the account a contact in the operator's own CRM, the moment it exists.\n *\n * The marketing box decides the person's marketing consent, not whether the\n * operator knows them: an account is a lead for the platform's CRM either\n * way. So the row is written at account creation, carrying no consent of its\n * own, and a Yes or a No recorded later by\n * {@link recordPlatformMarketingConsent} lands on this same row. Product email\n * does not read this row's consent; the account's notification settings\n * govern it.\n *\n * Quiet like the consent writer's contact half: a refused row is returned,\n * never thrown, because nothing about creating an account should fail over\n * the operator's CRM.\n */\nexport async function recordPlatformAccountContact(\n input: RecordPlatformAccountContactInput,\n): Promise<PlatformMarketingContactOutcome> {\n const uid = String(input.uid ?? '').trim()\n if (!uid) throw new Error('recordPlatformAccountContact: uid is required')\n const hostId =\n input.hostId === undefined ? platformMarketingHostId() : input.hostId\n if (!hostId) return { status: 'unconfigured' }\n const email = String(input.email ?? '').trim()\n if (!email) return { status: 'no-email' }\n\n const snapshot = await (input.firestore ?? firestore())\n .collection('users')\n .doc(uid)\n .get()\n const name = accountName(snapshot, input.name)\n const verdict = await (input.upsert ?? upsertHostContact)({\n hostId,\n email,\n ...(name ? { name } : {}),\n source: 'account',\n interaction: { atMs: input.createdAtMs, summary: PLATFORM_ACCOUNT_CREATED_SUMMARY },\n initialLifecycleStage: 'lead',\n })\n if ('refused' in verdict) return { status: 'refused', reason: verdict.refused }\n await stampRecordOrigin({ hostId, email, origin: 'account', firstTouchOnly: true })\n return { status: 'recorded', contactId: verdict.contactId, created: verdict.created }\n}\n\n/**\n * Stamps a prompt dismissal — no decision — so the console stays quiet for\n * the snooze window and asks once more after it.\n */\nexport async function snoozePlatformMarketingPrompt(\n uid: string,\n options: { now?: number; firestore?: any } = {},\n): Promise<{ atMs: number }> {\n const trimmed = String(uid ?? '').trim()\n if (!trimmed) throw new Error('snoozePlatformMarketingPrompt: uid is required')\n const atMs = options.now ?? Date.now()\n await (options.firestore ?? firestore())\n .collection('users')\n .doc(trimmed)\n .set({ [USER_MARKETING_PROMPT_DISMISSED_AT_FIELD]: atMs }, { merge: true })\n return { atMs }\n}\n\n/** The decision the person's own document holds, for the console to show. */\nexport async function readPlatformMarketingConsentForUser(\n uid: string,\n options: { firestore?: any } = {},\n): Promise<PlatformMarketingConsentState> {\n const trimmed = String(uid ?? '').trim()\n if (!trimmed) throw new Error('readPlatformMarketingConsentForUser: uid is required')\n const snapshot = await (options.firestore ?? firestore())\n .collection('users')\n .doc(trimmed)\n .get()\n return readPlatformMarketingConsent(\n (snapshot?.data?.() as Record<string, unknown> | undefined) ?? null,\n )\n}\n\n/** An entry on one of the two lists every campaign send passes. */\nexport interface PlatformMarketingSuppression {\n /** `site`: the marketing site's own list. `platform`: every sender's. */\n list: 'site' | 'platform'\n /** `unsubscribe` on the site list; `bounce`, `complaint` or `staff` platform-wide. */\n reason: string\n}\n\n/**\n * What the operator's own product email would decide about one address\n * (AGL-3292), read the way a campaign from the marketing site reads it.\n *\n * The decision the person made lives on `users/{uid}`, and nothing a send\n * does looks there. A campaign from the configured marketing site reads the\n * CONTACT `recordPlatformMarketingConsent` wrote into that site's\n * organization — its basis for the site, under the organization's policy —\n * and then drops anybody on either suppression list, and a campaign on the\n * product-updates list anybody who left it. An unsubscribe writes those\n * lists; since AGL-3305 one about product updates also turns the account's\n * answer to No, but the contact's basis stays as it was, because it covers\n * every list the site sends. So a staff reader asking \"may we email them?\"\n * needs this half, and needs it from the sender's own readers — the same\n * basis read, consent group, policy and lists — or it answers a question no\n * send asks.\n */\nexport type PlatformMarketingReach =\n /** No marketing site is configured — a self-hosted install. */\n | { status: 'unconfigured' }\n /** The account carries no address a contact could be keyed on. */\n | { status: 'no-email' }\n /** A read failed. Nothing about the person follows from it. */\n | { status: 'unreadable'; hostId: string }\n | {\n status: 'read'\n hostId: string\n orgId: string\n orgSlug: string | null\n /** `null` when the operator's CRM holds no contact for the address. */\n contactId: string | null\n basis: MarketingBasis\n basisAtMs: number | null\n /** Whose act the basis is — a person's own, or an operator's assertion. */\n assertedBy: MarketingConsentAssertedBy | null\n /** Which door recorded the basis (`console-signup`, a form, a backfill). */\n basisKind: string | null\n /** The consent rule's answer alone, before either list is consulted. */\n verdict: MarketingConsentVerdict\n reason: MarketingConsentReason\n /** The list that stops every send to the address, when one does. */\n suppression: PlatformMarketingSuppression | null\n /**\n * The address on the list the account's answer stands for (AGL-3305):\n * `opted-out` when they left product updates, `pending` while a\n * confirmation is unanswered. A campaign on that list drops both.\n */\n topic: PlatformMarketingTopicState\n }\n\n/** One address on {@link PLATFORM_MARKETING_TOPIC_ID}, as the site stores it. */\nexport interface PlatformMarketingTopicState {\n id: string\n state: TopicSubscriptionState\n /** When they left it, for an `opted-out` state; else `null`. */\n leftAtMs: number | null\n}\n\n/**\n * The entry that suppresses `email` for sends from `hostId`, if any.\n *\n * The site's own list first, because it is the one a person puts themselves\n * on from this sender's footer; the platform list second. The same two reads\n * `filterSendableForHost` makes: a site entry suppresses by existing, and a\n * platform entry until it is released.\n */\nasync function readPlatformMarketingSuppression(\n db: any,\n hostId: string,\n email: string,\n): Promise<PlatformMarketingSuppression | null> {\n const key = emailSuppressionKey(email)\n if (!key) return null\n const [site, platform] = await Promise.all([\n db\n .collection('hosts')\n .doc(hostId)\n .collection(HOST_SUPPRESSIONS_SUBCOLLECTION)\n .doc(key)\n .get(),\n db.collection(EMAIL_SUPPRESSIONS_COLLECTION).doc(key).get(),\n ])\n if (site?.exists) {\n return { list: 'site', reason: String(site.get('reason') ?? 'unsubscribe') }\n }\n if (platform?.exists && !platform.get('releasedAt')) {\n return { list: 'platform', reason: String(platform.get('reason') ?? 'staff') }\n }\n return null\n}\n\n/** Milliseconds from a stored Firestore timestamp or a number, else `null`. */\nfunction storedMs(value: unknown): number | null {\n if (typeof value === 'number' && Number.isFinite(value)) return value\n const toMillis = (value as { toMillis?: () => number } | null)?.toMillis\n return typeof toMillis === 'function' ? toMillis.call(value) : null\n}\n\n/**\n * Where the address stands on {@link PLATFORM_MARKETING_TOPIC_ID}.\n *\n * The site's per-topic record, read by key and through the one function that\n * knows its three states — the same read `filterTopicSendable` makes before\n * a campaign on that list goes out. No record is `subscribed`: nobody has\n * left a list they were never taken off.\n */\nasync function readPlatformMarketingTopic(\n db: any,\n hostId: string,\n email: string,\n): Promise<PlatformMarketingTopicState> {\n const key = emailSuppressionKey(email)\n const unrecorded = { id: PLATFORM_MARKETING_TOPIC_ID, state: 'subscribed' as const, leftAtMs: null }\n if (!key) return unrecorded\n const snapshot = await db\n .collection('hosts')\n .doc(hostId)\n .collection(TOPIC_OPT_OUTS_SUBCOLLECTION)\n .doc(key)\n .get()\n if (!snapshot?.exists) return unrecorded\n const entry = ((snapshot.get('topics') ?? {}) as Record<string, TopicSubscriptionEntry | undefined>)[\n PLATFORM_MARKETING_TOPIC_ID\n ]\n const state = readTopicSubscriptionState(entry)\n return {\n id: PLATFORM_MARKETING_TOPIC_ID,\n state,\n leftAtMs: state === 'opted-out' ? storedMs(entry?.optedOutAt) : null,\n }\n}\n\n/**\n * Reads {@link PlatformMarketingReach} for an address.\n *\n * Never throws: a failed read is `unreadable`, which the staff page shows as\n * unknown — never as \"no consent\", which would be a claim about the person.\n */\nexport async function readPlatformMarketingReach(input: {\n email: string | null | undefined\n /** Injectable for tests; defaults to {@link platformMarketingHostId}. */\n hostId?: string | null\n /** Injectable for tests; defaults to the admin app's Firestore. */\n firestore?: any\n}): Promise<PlatformMarketingReach> {\n const hostId =\n input.hostId === undefined ? platformMarketingHostId() : input.hostId\n if (!hostId) return { status: 'unconfigured' }\n const email = String(input.email ?? '').trim().toLowerCase()\n if (!email) return { status: 'no-email' }\n const db = input.firestore ?? firestore()\n try {\n const owner = await getOrgForHost(hostId)\n if (!owner) return { status: 'unreadable', hostId }\n const org = owner.org as Record<string, unknown>\n const [person, group, suppression, topic] = await Promise.all([\n // The operator's person for the address, asked of the plugin that\n // keeps people (AGL-3080) — the record the capture door wrote.\n findPluginPerson({ orgId: owner.orgId, hostId, email }),\n consentGroupForSite(hostId, org),\n readPlatformMarketingSuppression(db, hostId, email),\n readPlatformMarketingTopic(db, hostId, email),\n ])\n const record = readMarketingBasis(person ? { ...person.data } : null, group)\n const decision = marketingConsentDecision(\n record,\n resolveMarketingConsentPolicy(org['marketingConsentPolicy']),\n )\n return {\n status: 'read',\n hostId,\n orgId: owner.orgId,\n orgSlug: typeof org['slug'] === 'string' ? org['slug'] : null,\n contactId: person?.id ?? null,\n basis: record.basis,\n basisAtMs: record.basisAtMs,\n assertedBy: record.assertedBy,\n basisKind: record.source?.kind ?? null,\n verdict: decision.verdict,\n reason: decision.reason,\n suppression,\n topic,\n }\n } catch (error) {\n console.error('[platform-marketing-consent] reach read failed', error)\n return { status: 'unreadable', hostId }\n }\n}\n\n/**\n * Why somebody who said Yes will not receive product updates, in the terms\n * of what they can do about it (AGL-3305) — or `null` when nothing on the\n * marketing site's lists stands in the way.\n *\n * - `unsubscribed`: they left everything, or left product updates, from an\n * email. Theirs to undo, and a Yes from a verified account does.\n * - `unconfirmed`: a confirmation for the list was asked and not answered.\n * - `paused`: a bounce, a complaint, an erasure or a staff hold. Not a\n * preference, so no switch of theirs lifts it.\n *\n * The consent basis is not judged here: the Yes this is asked about is the\n * basis. Only the lists a Yes cannot overrule are.\n */\nexport type PlatformMarketingHold =\n | { kind: 'unsubscribed' }\n | { kind: 'unconfirmed' }\n | { kind: 'paused'; reason: string }\n\nexport function platformMarketingHold(\n reach: PlatformMarketingReach,\n): PlatformMarketingHold | null {\n if (reach.status !== 'read') return null\n if (reach.suppression) {\n return reach.suppression.list === 'site' && reach.suppression.reason === 'unsubscribe'\n ? { kind: 'unsubscribed' }\n : { kind: 'paused', reason: reach.suppression.reason }\n }\n if (reach.topic.state === 'opted-out') return { kind: 'unsubscribed' }\n if (reach.topic.state === 'pending') return { kind: 'unconfirmed' }\n return null\n}\n\n/** What mirroring an email-side change onto the account did (AGL-3305). */\nexport type PlatformMarketingMirrorOutcome =\n /** Another site's list. An account is never touched from one. */\n | { status: 'not-platform' }\n /** A list the account's answer is not about. */\n | { status: 'other-list' }\n /** No account holds the address — or more than one does. */\n | { status: 'no-account' }\n /** The account already says so, or the rule leaves it where it is. */\n | { status: 'unchanged' }\n | { status: 'recorded'; uid: string; decision: PlatformMarketingConsentDecision }\n /** Logged; the site's own write, which is what stops the mail, stands. */\n | { status: 'failed' }\n\nexport interface PlatformMarketingMirrorInput {\n /** The site whose page the person used. */\n hostId: string\n /** The address the signed link was for. */\n email: string\n /** Injectable for tests; defaults to the clock. */\n now?: number\n /** Injectable for tests; defaults to the admin app's Firestore. */\n firestore?: any\n /** Injectable for tests; defaults to {@link platformMarketingHostId}. */\n platformHostId?: string | null\n /**\n * Injectable for tests; defaults to `attributableAccountForAddress`, which\n * answers `null` for nobody AND for more than one account. Changing the\n * wrong person's answer is worse than changing nobody's.\n */\n findAccount?: (email: string) => Promise<string | null>\n}\n\n/** The account a mirror would write, or the reason there is none. */\nasync function mirrorTarget(\n input: PlatformMarketingMirrorInput,\n): Promise<{ uid: string; ref: any; state: PlatformMarketingConsentState } | PlatformMarketingMirrorOutcome> {\n const platformHost =\n input.platformHostId === undefined ? platformMarketingHostId() : input.platformHostId\n if (!platformHost || input.hostId !== platformHost) return { status: 'not-platform' }\n const uid = await (input.findAccount ?? ((email: string) => attributableAccountForAddress(email)))(\n input.email,\n )\n if (!uid) return { status: 'no-account' }\n const ref = (input.firestore ?? firestore()).collection('users').doc(uid)\n const snapshot = await ref.get()\n return {\n uid,\n ref,\n state: readPlatformMarketingConsent(\n (snapshot?.data?.() as Record<string, unknown> | undefined) ?? null,\n ),\n }\n}\n\n/**\n * Mirrors an unsubscribe from the marketing site onto the account's answer.\n *\n * Called by the site's own pages AFTER their write, with what the person\n * left: `'everything'` for the site's list, or the topics left on the\n * preference page. Only the platform's marketing site counts, and only a\n * list the answer is about — {@link PLATFORM_MARKETING_TOPIC_ID}, which\n * everything includes. The first No keeps its date and its door: a second\n * unsubscribe is not a later decision.\n *\n * Never throws. The page has already stopped the mail; this is the account\n * catching up with it.\n */\nexport async function mirrorPlatformUnsubscribe(\n input: PlatformMarketingMirrorInput & { left: 'everything' | readonly string[] },\n): Promise<PlatformMarketingMirrorOutcome> {\n try {\n const everything = input.left === 'everything'\n if (!everything && !input.left.includes(PLATFORM_MARKETING_TOPIC_ID)) {\n // Cheaper to answer before the account lookup, and the answer does not\n // depend on the site: no other list is this one on any site.\n const platformHost =\n input.platformHostId === undefined ? platformMarketingHostId() : input.platformHostId\n return input.hostId === platformHost ? { status: 'other-list' } : { status: 'not-platform' }\n }\n const target = await mirrorTarget(input)\n if ('status' in target) return target\n if (target.state.decision === 'declined') return { status: 'unchanged' }\n const atMs = input.now ?? Date.now()\n const source = platformMarketingEmailSource(\n everything\n ? { kind: 'email-unsubscribe', decision: 'declined', uid: target.uid, atMs }\n : { kind: 'email-preferences', decision: 'declined', uid: target.uid, atMs },\n )\n await target.ref.set(\n platformMarketingUserFields({ decision: 'declined', atMs, source }),\n { merge: true },\n )\n return { status: 'recorded', uid: target.uid, decision: 'declined' }\n } catch (error) {\n console.error('[platform-marketing-consent] could not mirror an unsubscribe onto the account', error)\n return { status: 'failed' }\n }\n}\n\n/**\n * Mirrors a way back in from the marketing site: the resubscribe link, or\n * the list ticked again on the preference page.\n *\n * Narrower than the unsubscribe on purpose. It restores only a No that an\n * email door recorded — a No given in the console is the person's answer in\n * the console, and a link in an email does not overturn it — and only once\n * product updates would really reach them: nothing on either suppression\n * list, and the list itself not left. A resubscribe that lifted the site's\n * list while product updates stay unticked restores nothing.\n */\nexport async function mirrorPlatformResubscribe(\n input: PlatformMarketingMirrorInput & { via: 'email-resubscribe' | 'email-preferences' },\n): Promise<PlatformMarketingMirrorOutcome> {\n try {\n const target = await mirrorTarget(input)\n if ('status' in target) return target\n if (\n target.state.decision !== 'declined' ||\n !isPlatformMarketingEmailSourceKind(target.state.sourceKind)\n ) {\n return { status: 'unchanged' }\n }\n const db = input.firestore ?? firestore()\n const [suppression, topic] = await Promise.all([\n readPlatformMarketingSuppression(db, input.hostId, input.email),\n readPlatformMarketingTopic(db, input.hostId, input.email),\n ])\n if (suppression || topic.state !== 'subscribed') return { status: 'unchanged' }\n const atMs = input.now ?? Date.now()\n const source = platformMarketingEmailSource({\n kind: input.via,\n decision: 'granted',\n uid: target.uid,\n atMs,\n })\n await target.ref.set(\n platformMarketingUserFields({ decision: 'granted', atMs, source }),\n { merge: true },\n )\n return { status: 'recorded', uid: target.uid, decision: 'granted' }\n } catch (error) {\n console.error('[platform-marketing-consent] could not mirror a resubscribe onto the account', error)\n return { status: 'failed' }\n }\n}\n"],"names":["stampRecordOrigin","readTopicSubscriptionState","TOPIC_OPT_OUTS_SUBCOLLECTION","isPlatformMarketingConsentDecision","isPlatformMarketingConsoleSourceKind","isPlatformMarketingEmailSourceKind","platformMarketingConsentSource","platformMarketingEmailSource","PLATFORM_MARKETING_TOPIC_ID","platformMarketingUserFields","readPlatformMarketingConsent","USER_MARKETING_PROMPT_DISMISSED_AT_FIELD","marketingConsentDecision","readMarketingBasis","resolveMarketingConsentPolicy","rejoinEmailStream","attributableAccountForAddress","findPluginPerson","EMAIL_SUPPRESSIONS_COLLECTION","emailSuppressionKey","HOST_SUPPRESSIONS_SUBCOLLECTION","firebaseAdmin","consentGroupForSite","getOrgForHost","upsertHostContact","firestore","app","PLATFORM_MARKETING_HOST_ID_ENV","platformMarketingHostId","process","value","String","env","PLATFORM_MARKETING_HOST_ID","trim","accountName","snapshot","fallback","first","get","last","stored","filter","Boolean","join","undefined","recordPlatformMarketingConsent","input","uid","Error","decision","source","textVersion","atMs","now","Date","kind","userRef","collection","doc","set","merge","hostId","contact","status","email","name","verdict","upsert","interaction","summary","reason","marketingConsent","declineMarketingConsent","marketingConsentSource","initialLifecycleStage","refused","contactId","created","origin","firstTouchOnly","stream","mailboxVerified","rejoin","topicId","PLATFORM_ACCOUNT_CREATED_SUMMARY","recordPlatformAccountContact","createdAtMs","snoozePlatformMarketingPrompt","options","trimmed","readPlatformMarketingConsentForUser","data","readPlatformMarketingSuppression","db","key","site","platform","Promise","all","exists","list","storedMs","Number","isFinite","toMillis","call","readPlatformMarketingTopic","unrecorded","id","state","leftAtMs","entry","optedOutAt","readPlatformMarketingReach","toLowerCase","record","owner","org","person","group","suppression","topic","orgId","orgSlug","basis","basisAtMs","assertedBy","basisKind","error","console","platformMarketingHold","reach","mirrorTarget","platformHost","platformHostId","findAccount","ref","mirrorPlatformUnsubscribe","everything","left","includes","target","mirrorPlatformResubscribe","sourceKind","via"],"mappings":";AAAA;;;;;;;;;;;;;;;CAeC,GAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAgDC,GAED,SAASA,iBAAiB,QAAQ,mDAAkD;AACpF,SACEC,0BAA0B,EAC1BC,4BAA4B,QAGvB,6CAA4C;AACnD,SACEC,kCAAkC,EAClCC,oCAAoC,EACpCC,kCAAkC,EAIlCC,8BAA8B,EAC9BC,4BAA4B,EAC5BC,2BAA2B,EAC3BC,2BAA2B,EAC3BC,4BAA4B,EAC5BC,wCAAwC,QACnC,oDAAmD;AAC1D,SACEC,wBAAwB,EAKxBC,kBAAkB,EAClBC,6BAA6B,QACxB,2CAA0C;AACjD,SAEEC,iBAAiB,QACZ,mDAAkD;AACzD,SAASC,6BAA6B,QAAQ,yBAAqB;AACnE,SAASC,gBAAgB,QAAQ,oDAAmD;AACpF,SACEC,6BAA6B,EAC7BC,mBAAmB,EACnBC,+BAA+B,QAC1B,yBAAqB;AAC5B,OAAOC,mBAAmB,sBAAkB;AAC5C,SAASC,mBAAmB,EAAEC,aAAa,QAAQ,qBAAiB;AACpE,SAASC,iBAAiB,QAAQ,sBAAkB;AAEpD,MAAMC,YAAY,IAAMJ,cAAcK,GAAG,GAAGD,SAAS;AAErD;;;;CAIC,GACD,OAAO,MAAME,iCAAiC,6BAA4B;AAE1E;;;;;;CAMC,GACD,OAAO,SAASC;QACOC;IAArB,MAAMC,QAAQC,QAAOF,0CAAAA,QAAQG,GAAG,CAACC,0BAA0B,YAAtCJ,0CAA0C,IAAIK,IAAI;IACvE,OAAOJ,SAAS;AAClB;AA0DA;;;;;;CAMC,GACD,SAASK,YACPC,QAAiE,EACjEC,QAAmC;;QAEdD,eACDA;IADpB,MAAME,QAAQP,eAAOK,6BAAAA,gBAAAA,SAAUG,GAAG,qBAAbH,mBAAAA,UAAgB,+BAAgB,IAAIF,IAAI;IAC7D,MAAMM,OAAOT,gBAAOK,6BAAAA,iBAAAA,SAAUG,GAAG,qBAAbH,oBAAAA,UAAgB,+BAAe,IAAIF,IAAI;IAC3D,MAAMO,SAAS;QAACH;QAAOE;KAAK,CAACE,MAAM,CAACC,SAASC,IAAI,CAAC;IAClD,OAAOH,UAAUV,OAAOM,mBAAAA,WAAY,IAAIH,IAAI,MAAMW;AACpD;AAEA;;;;;;;;CAQC,GACD,OAAO,eAAeC,+BACpBC,KAA0C;QAEvBA,YAQQA,oBAKdA,YASIA,kBAUIA,cAIEA,eAsCZA;IA1EX,MAAMC,MAAMjB,QAAOgB,aAAAA,MAAMC,GAAG,YAATD,aAAa,IAAIb,IAAI;IACxC,IAAI,CAACc,KAAK,MAAM,IAAIC,MAAM;IAC1B,IAAI,CAAC9C,mCAAmC4C,MAAMG,QAAQ,GAAG;QACvD,MAAM,IAAID,MAAM;IAClB;IACA,IAAI,CAAC7C,qCAAqC2C,MAAMI,MAAM,GAAG;QACvD,MAAM,IAAIF,MAAM;IAClB;IACA,MAAMG,cAAcrB,QAAOgB,qBAAAA,MAAMK,WAAW,YAAjBL,qBAAqB,IAAIb,IAAI;IACxD,IAAI,CAACkB,aAAa;QAChB,MAAM,IAAIH,MAAM;IAClB;IAEA,MAAMI,QAAON,aAAAA,MAAMO,GAAG,YAATP,aAAaQ,KAAKD,GAAG;IAClC,MAAMH,SAAS7C,+BAA+B;QAC5CkD,MAAMT,MAAMI,MAAM;QAClBD,UAAUH,MAAMG,QAAQ;QACxBF;QACAK;QACAD;IACF;IAEA,MAAMK,UAAU,EAACV,mBAAAA,MAAMtB,SAAS,YAAfsB,mBAAmBtB,aAAaiC,UAAU,CAAC,SAASC,GAAG,CAACX;IACzE,MAAMZ,WAAW,MAAMqB,QAAQlB,GAAG;IAClC,MAAMkB,QAAQG,GAAG,CACfnD,4BAA4B;QAAEyC,UAAUH,MAAMG,QAAQ;QAAEG;QAAMF;IAAO,IACrE;QAAEU,OAAO;IAAK;IAGhB,MAAMC,SACJf,MAAMe,MAAM,KAAKjB,YAAYjB,4BAA4BmB,MAAMe,MAAM;IACvE,IAAI,CAACA,QAAQ,OAAO;QAAET;QAAMU,SAAS;YAAEC,QAAQ;QAAe;IAAE;IAChE,MAAMC,QAAQlC,QAAOgB,eAAAA,MAAMkB,KAAK,YAAXlB,eAAe,IAAIb,IAAI;IAC5C,IAAI,CAAC+B,OAAO,OAAO;QAAEZ;QAAMU,SAAS;YAAEC,QAAQ;QAAW;IAAE;IAE3D,MAAME,OAAO/B,YAAYC,UAAUW,MAAMmB,IAAI;IAC7C,MAAMC,UAAU,MAAM,EAACpB,gBAAAA,MAAMqB,MAAM,YAAZrB,gBAAgBvB,mBAAmB;QACxDsC;QACAG;OACIC,OAAO;QAAEA;IAAK,IAAI,CAAC;QACvBf,QAAQ;QACR,uEAAuE;QACvE,iDAAiD;QACjDkB,aAAa;YAAEhB;YAAMiB,SAASnB,OAAOoB,MAAM;QAAC;OACxCxB,MAAMG,QAAQ,KAAK,YACnB;QAAEsB,kBAAkB;IAAK,IACzB;QAAEC,yBAAyB;IAAK;QACpCC,wBAAwBvB;QACxB,uEAAuE;QACvE,wEAAwE;QACxE,mBAAmB;QACnBwB,uBAAuB;;IAEzB,MAAMZ,UACJ,aAAaI,UACT;QAAEH,QAAQ;QAAWO,QAAQJ,QAAQS,OAAO;IAAC,IAC7C;QAAEZ,QAAQ;QAAYa,WAAWV,QAAQU,SAAS;QAAEC,SAASX,QAAQW,OAAO;IAAC;IACnF,yEAAyE;IACzE,qEAAqE;IACrE,IAAIf,QAAQC,MAAM,KAAK,YAAY;QACjC,MAAMhE,kBAAkB;YAAE8D;YAAQG;YAAOc,QAAQ;YAAWC,gBAAgB;QAAK;IACnF;IACA,IAAIjC,MAAMG,QAAQ,KAAK,WAAW,OAAO;QAAEG;QAAMU;IAAQ;IAEzD;;;;;;;;GAQC,GACD,MAAMkB,SAAyClC,MAAMmC,eAAe,GAChE,MAAM,EAACnC,gBAAAA,MAAMoC,MAAM,YAAZpC,gBAAgBhC,mBAAmB;QACxC+C;QACAG;QACAmB,SAAS5E;IACX,KACA;QAAEwD,QAAQ;IAAa;IAC3B,OAAO;QAAEX;QAAMU;QAASkB;IAAO;AACjC;AAEA,0DAA0D,GAC1D,OAAO,MAAMI,mCAAmC,qBAAoB;AAkBpE;;;;;;;;;;;;;;CAcC,GACD,OAAO,eAAeC,6BACpBvC,KAAwC;QAErBA,YAKEA,cAGGA,kBAKDA;IAbvB,MAAMC,MAAMjB,QAAOgB,aAAAA,MAAMC,GAAG,YAATD,aAAa,IAAIb,IAAI;IACxC,IAAI,CAACc,KAAK,MAAM,IAAIC,MAAM;IAC1B,MAAMa,SACJf,MAAMe,MAAM,KAAKjB,YAAYjB,4BAA4BmB,MAAMe,MAAM;IACvE,IAAI,CAACA,QAAQ,OAAO;QAAEE,QAAQ;IAAe;IAC7C,MAAMC,QAAQlC,QAAOgB,eAAAA,MAAMkB,KAAK,YAAXlB,eAAe,IAAIb,IAAI;IAC5C,IAAI,CAAC+B,OAAO,OAAO;QAAED,QAAQ;IAAW;IAExC,MAAM5B,WAAW,MAAM,EAACW,mBAAAA,MAAMtB,SAAS,YAAfsB,mBAAmBtB,aACxCiC,UAAU,CAAC,SACXC,GAAG,CAACX,KACJT,GAAG;IACN,MAAM2B,OAAO/B,YAAYC,UAAUW,MAAMmB,IAAI;IAC7C,MAAMC,UAAU,MAAM,EAACpB,gBAAAA,MAAMqB,MAAM,YAAZrB,gBAAgBvB,mBAAmB;QACxDsC;QACAG;OACIC,OAAO;QAAEA;IAAK,IAAI,CAAC;QACvBf,QAAQ;QACRkB,aAAa;YAAEhB,MAAMN,MAAMwC,WAAW;YAAEjB,SAASe;QAAiC;QAClFV,uBAAuB;;IAEzB,IAAI,aAAaR,SAAS,OAAO;QAAEH,QAAQ;QAAWO,QAAQJ,QAAQS,OAAO;IAAC;IAC9E,MAAM5E,kBAAkB;QAAE8D;QAAQG;QAAOc,QAAQ;QAAWC,gBAAgB;IAAK;IACjF,OAAO;QAAEhB,QAAQ;QAAYa,WAAWV,QAAQU,SAAS;QAAEC,SAASX,QAAQW,OAAO;IAAC;AACtF;AAEA;;;CAGC,GACD,OAAO,eAAeU,8BACpBxC,GAAW,EACXyC,UAA6C,CAAC,CAAC;QAIlCA,cACNA;IAHP,MAAMC,UAAU3D,OAAOiB,cAAAA,MAAO,IAAId,IAAI;IACtC,IAAI,CAACwD,SAAS,MAAM,IAAIzC,MAAM;IAC9B,MAAMI,QAAOoC,eAAAA,QAAQnC,GAAG,YAAXmC,eAAelC,KAAKD,GAAG;IACpC,MAAM,EAACmC,qBAAAA,QAAQhE,SAAS,YAAjBgE,qBAAqBhE,aACzBiC,UAAU,CAAC,SACXC,GAAG,CAAC+B,SACJ9B,GAAG,CAAC;QAAE,CAACjD,yCAAyC,EAAE0C;IAAK,GAAG;QAAEQ,OAAO;IAAK;IAC3E,OAAO;QAAER;IAAK;AAChB;AAEA,2EAA2E,GAC3E,OAAO,eAAesC,oCACpB3C,GAAW,EACXyC,UAA+B,CAAC,CAAC;QAITA;QAKrBrD;IAPH,MAAMsD,UAAU3D,OAAOiB,cAAAA,MAAO,IAAId,IAAI;IACtC,IAAI,CAACwD,SAAS,MAAM,IAAIzC,MAAM;IAC9B,MAAMb,WAAW,MAAM,EAACqD,qBAAAA,QAAQhE,SAAS,YAAjBgE,qBAAqBhE,aAC1CiC,UAAU,CAAC,SACXC,GAAG,CAAC+B,SACJnD,GAAG;IACN,OAAO7B,qCACJ0B,6BAAAA,iBAAAA,SAAUwD,IAAI,qBAAdxD,oBAAAA,4BAA8D;AAEnE;AAoEA;;;;;;;CAOC,GACD,eAAeyD,iCACbC,EAAO,EACPhC,MAAc,EACdG,KAAa;IAEb,MAAM8B,MAAM5E,oBAAoB8C;IAChC,IAAI,CAAC8B,KAAK,OAAO;IACjB,MAAM,CAACC,MAAMC,SAAS,GAAG,MAAMC,QAAQC,GAAG,CAAC;QACzCL,GACGpC,UAAU,CAAC,SACXC,GAAG,CAACG,QACJJ,UAAU,CAACtC,iCACXuC,GAAG,CAACoC,KACJxD,GAAG;QACNuD,GAAGpC,UAAU,CAACxC,+BAA+ByC,GAAG,CAACoC,KAAKxD,GAAG;KAC1D;IACD,IAAIyD,wBAAAA,KAAMI,MAAM,EAAE;YACsBJ;QAAtC,OAAO;YAAEK,MAAM;YAAQ9B,QAAQxC,QAAOiE,YAAAA,KAAKzD,GAAG,CAAC,qBAATyD,YAAsB;QAAe;IAC7E;IACA,IAAIC,CAAAA,4BAAAA,SAAUG,MAAM,KAAI,CAACH,SAAS1D,GAAG,CAAC,eAAe;YACT0D;QAA1C,OAAO;YAAEI,MAAM;YAAY9B,QAAQxC,QAAOkE,gBAAAA,SAAS1D,GAAG,CAAC,qBAAb0D,gBAA0B;QAAS;IAC/E;IACA,OAAO;AACT;AAEA,6EAA6E,GAC7E,SAASK,SAASxE,KAAc;IAC9B,IAAI,OAAOA,UAAU,YAAYyE,OAAOC,QAAQ,CAAC1E,QAAQ,OAAOA;IAChE,MAAM2E,WAAY3E,yBAAD,AAACA,MAA8C2E,QAAQ;IACxE,OAAO,OAAOA,aAAa,aAAaA,SAASC,IAAI,CAAC5E,SAAS;AACjE;AAEA;;;;;;;CAOC,GACD,eAAe6E,2BACbb,EAAO,EACPhC,MAAc,EACdG,KAAa;QAYG7B;IAVhB,MAAM2D,MAAM5E,oBAAoB8C;IAChC,MAAM2C,aAAa;QAAEC,IAAIrG;QAA6BsG,OAAO;QAAuBC,UAAU;IAAK;IACnG,IAAI,CAAChB,KAAK,OAAOa;IACjB,MAAMxE,WAAW,MAAM0D,GACpBpC,UAAU,CAAC,SACXC,GAAG,CAACG,QACJJ,UAAU,CAACxD,8BACXyD,GAAG,CAACoC,KACJxD,GAAG;IACN,IAAI,EAACH,4BAAAA,SAAUgE,MAAM,GAAE,OAAOQ;IAC9B,MAAMI,QAAQ,EAAE5E,gBAAAA,SAASG,GAAG,CAAC,qBAAbH,gBAA0B,CAAC,EAAyD,CAClG5B,4BACD;IACD,MAAMsG,QAAQ7G,2BAA2B+G;IACzC,OAAO;QACLH,IAAIrG;QACJsG;QACAC,UAAUD,UAAU,cAAcR,SAASU,yBAAAA,MAAOC,UAAU,IAAI;IAClE;AACF;AAEA;;;;;CAKC,GACD,OAAO,eAAeC,2BAA2BnE,KAMhD;QAIsBA,cAEVA;IALX,MAAMe,SACJf,MAAMe,MAAM,KAAKjB,YAAYjB,4BAA4BmB,MAAMe,MAAM;IACvE,IAAI,CAACA,QAAQ,OAAO;QAAEE,QAAQ;IAAe;IAC7C,MAAMC,QAAQlC,QAAOgB,eAAAA,MAAMkB,KAAK,YAAXlB,eAAe,IAAIb,IAAI,GAAGiF,WAAW;IAC1D,IAAI,CAAClD,OAAO,OAAO;QAAED,QAAQ;IAAW;IACxC,MAAM8B,MAAK/C,mBAAAA,MAAMtB,SAAS,YAAfsB,mBAAmBtB;IAC9B,IAAI;;YA0BW2F;QAzBb,MAAMC,QAAQ,MAAM9F,cAAcuC;QAClC,IAAI,CAACuD,OAAO,OAAO;YAAErD,QAAQ;YAAcF;QAAO;QAClD,MAAMwD,MAAMD,MAAMC,GAAG;QACrB,MAAM,CAACC,QAAQC,OAAOC,aAAaC,MAAM,GAAG,MAAMxB,QAAQC,GAAG,CAAC;YAC5D,kEAAkE;YAClE,+DAA+D;YAC/DlF,iBAAiB;gBAAE0G,OAAON,MAAMM,KAAK;gBAAE7D;gBAAQG;YAAM;YACrD3C,oBAAoBwC,QAAQwD;YAC5BzB,iCAAiCC,IAAIhC,QAAQG;YAC7C0C,2BAA2Bb,IAAIhC,QAAQG;SACxC;QACD,MAAMmD,SAASvG,mBAAmB0G,SAAS,aAAKA,OAAO3B,IAAI,IAAK,MAAM4B;QACtE,MAAMtE,WAAWtC,yBACfwG,QACAtG,8BAA8BwG,GAAG,CAAC,yBAAyB;QAE7D,OAAO;YACLtD,QAAQ;YACRF;YACA6D,OAAON,MAAMM,KAAK;YAClBC,SAAS,OAAON,GAAG,CAAC,OAAO,KAAK,WAAWA,GAAG,CAAC,OAAO,GAAG;YACzDzC,SAAS,UAAE0C,0BAAAA,OAAQV,EAAE,mBAAI;YACzBgB,OAAOT,OAAOS,KAAK;YACnBC,WAAWV,OAAOU,SAAS;YAC3BC,YAAYX,OAAOW,UAAU;YAC7BC,SAAS,YAAEZ,iBAAAA,OAAOjE,MAAM,qBAAbiE,eAAe5D,IAAI,oBAAI;YAClCW,SAASjB,SAASiB,OAAO;YACzBI,QAAQrB,SAASqB,MAAM;YACvBkD;YACAC;QACF;IACF,EAAE,OAAOO,OAAO;QACdC,QAAQD,KAAK,CAAC,kDAAkDA;QAChE,OAAO;YAAEjE,QAAQ;YAAcF;QAAO;IACxC;AACF;AAqBA,OAAO,SAASqE,sBACdC,KAA6B;IAE7B,IAAIA,MAAMpE,MAAM,KAAK,QAAQ,OAAO;IACpC,IAAIoE,MAAMX,WAAW,EAAE;QACrB,OAAOW,MAAMX,WAAW,CAACpB,IAAI,KAAK,UAAU+B,MAAMX,WAAW,CAAClD,MAAM,KAAK,gBACrE;YAAEf,MAAM;QAAe,IACvB;YAAEA,MAAM;YAAUe,QAAQ6D,MAAMX,WAAW,CAAClD,MAAM;QAAC;IACzD;IACA,IAAI6D,MAAMV,KAAK,CAACZ,KAAK,KAAK,aAAa,OAAO;QAAEtD,MAAM;IAAe;IACrE,IAAI4E,MAAMV,KAAK,CAACZ,KAAK,KAAK,WAAW,OAAO;QAAEtD,MAAM;IAAc;IAClE,OAAO;AACT;AAmCA,mEAAmE,GACnE,eAAe6E,aACbtF,KAAmC;QAKhBA,oBAINA;QAMRX;IAbL,MAAMkG,eACJvF,MAAMwF,cAAc,KAAK1F,YAAYjB,4BAA4BmB,MAAMwF,cAAc;IACvF,IAAI,CAACD,gBAAgBvF,MAAMe,MAAM,KAAKwE,cAAc,OAAO;QAAEtE,QAAQ;IAAe;IACpF,MAAMhB,MAAM,MAAM,EAACD,qBAAAA,MAAMyF,WAAW,YAAjBzF,qBAAsB,CAACkB,QAAkBjD,8BAA8BiD,QACxFlB,MAAMkB,KAAK;IAEb,IAAI,CAACjB,KAAK,OAAO;QAAEgB,QAAQ;IAAa;IACxC,MAAMyE,MAAM,EAAC1F,mBAAAA,MAAMtB,SAAS,YAAfsB,mBAAmBtB,aAAaiC,UAAU,CAAC,SAASC,GAAG,CAACX;IACrE,MAAMZ,WAAW,MAAMqG,IAAIlG,GAAG;IAC9B,OAAO;QACLS;QACAyF;QACA3B,OAAOpG,qCACJ0B,6BAAAA,iBAAAA,SAAUwD,IAAI,qBAAdxD,oBAAAA,4BAA8D;IAEnE;AACF;AAEA;;;;;;;;;;;;CAYC,GACD,OAAO,eAAesG,0BACpB3F,KAAgF;IAEhF,IAAI;YAYWA;QAXb,MAAM4F,aAAa5F,MAAM6F,IAAI,KAAK;QAClC,IAAI,CAACD,cAAc,CAAC5F,MAAM6F,IAAI,CAACC,QAAQ,CAACrI,8BAA8B;YACpE,uEAAuE;YACvE,6DAA6D;YAC7D,MAAM8H,eACJvF,MAAMwF,cAAc,KAAK1F,YAAYjB,4BAA4BmB,MAAMwF,cAAc;YACvF,OAAOxF,MAAMe,MAAM,KAAKwE,eAAe;gBAAEtE,QAAQ;YAAa,IAAI;gBAAEA,QAAQ;YAAe;QAC7F;QACA,MAAM8E,SAAS,MAAMT,aAAatF;QAClC,IAAI,YAAY+F,QAAQ,OAAOA;QAC/B,IAAIA,OAAOhC,KAAK,CAAC5D,QAAQ,KAAK,YAAY,OAAO;YAAEc,QAAQ;QAAY;QACvE,MAAMX,QAAON,aAAAA,MAAMO,GAAG,YAATP,aAAaQ,KAAKD,GAAG;QAClC,MAAMH,SAAS5C,6BACboI,aACI;YAAEnF,MAAM;YAAqBN,UAAU;YAAYF,KAAK8F,OAAO9F,GAAG;YAAEK;QAAK,IACzE;YAAEG,MAAM;YAAqBN,UAAU;YAAYF,KAAK8F,OAAO9F,GAAG;YAAEK;QAAK;QAE/E,MAAMyF,OAAOL,GAAG,CAAC7E,GAAG,CAClBnD,4BAA4B;YAAEyC,UAAU;YAAYG;YAAMF;QAAO,IACjE;YAAEU,OAAO;QAAK;QAEhB,OAAO;YAAEG,QAAQ;YAAYhB,KAAK8F,OAAO9F,GAAG;YAAEE,UAAU;QAAW;IACrE,EAAE,OAAO+E,OAAO;QACdC,QAAQD,KAAK,CAAC,iFAAiFA;QAC/F,OAAO;YAAEjE,QAAQ;QAAS;IAC5B;AACF;AAEA;;;;;;;;;;CAUC,GACD,OAAO,eAAe+E,0BACpBhG,KAAwF;IAExF,IAAI;YASSA,kBAMEA;QAdb,MAAM+F,SAAS,MAAMT,aAAatF;QAClC,IAAI,YAAY+F,QAAQ,OAAOA;QAC/B,IACEA,OAAOhC,KAAK,CAAC5D,QAAQ,KAAK,cAC1B,CAAC7C,mCAAmCyI,OAAOhC,KAAK,CAACkC,UAAU,GAC3D;YACA,OAAO;gBAAEhF,QAAQ;YAAY;QAC/B;QACA,MAAM8B,MAAK/C,mBAAAA,MAAMtB,SAAS,YAAfsB,mBAAmBtB;QAC9B,MAAM,CAACgG,aAAaC,MAAM,GAAG,MAAMxB,QAAQC,GAAG,CAAC;YAC7CN,iCAAiCC,IAAI/C,MAAMe,MAAM,EAAEf,MAAMkB,KAAK;YAC9D0C,2BAA2Bb,IAAI/C,MAAMe,MAAM,EAAEf,MAAMkB,KAAK;SACzD;QACD,IAAIwD,eAAeC,MAAMZ,KAAK,KAAK,cAAc,OAAO;YAAE9C,QAAQ;QAAY;QAC9E,MAAMX,QAAON,aAAAA,MAAMO,GAAG,YAATP,aAAaQ,KAAKD,GAAG;QAClC,MAAMH,SAAS5C,6BAA6B;YAC1CiD,MAAMT,MAAMkG,GAAG;YACf/F,UAAU;YACVF,KAAK8F,OAAO9F,GAAG;YACfK;QACF;QACA,MAAMyF,OAAOL,GAAG,CAAC7E,GAAG,CAClBnD,4BAA4B;YAAEyC,UAAU;YAAWG;YAAMF;QAAO,IAChE;YAAEU,OAAO;QAAK;QAEhB,OAAO;YAAEG,QAAQ;YAAYhB,KAAK8F,OAAO9F,GAAG;YAAEE,UAAU;QAAU;IACpE,EAAE,OAAO+E,OAAO;QACdC,QAAQD,KAAK,CAAC,gFAAgFA;QAC9F,OAAO;YAAEjE,QAAQ;QAAS;IAC5B;AACF"}
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @license
|
|
3
|
+
* Copyright 2026 Aglyn LLC
|
|
4
|
+
*
|
|
5
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
+
* you may not use this file except in compliance with the License.
|
|
7
|
+
* You may obtain a copy of the License at
|
|
8
|
+
*
|
|
9
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
*
|
|
11
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
12
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
+
* See the License for the specific language governing permissions and
|
|
15
|
+
* limitations under the License.
|
|
16
|
+
*/
|
|
17
|
+
import type { ProjectDomainStatus } from './domain-provider';
|
|
18
|
+
/** The host fields a domain decision reads, and nothing else. */
|
|
19
|
+
export interface HostDomainRecord {
|
|
20
|
+
id: string;
|
|
21
|
+
subdomain?: string | null;
|
|
22
|
+
cname?: string | null;
|
|
23
|
+
cnameTwin?: string | null;
|
|
24
|
+
cnameAttachmentPending?: boolean | null;
|
|
25
|
+
cnameDetachmentPending?: boolean | null;
|
|
26
|
+
cnameTwinPending?: boolean | null;
|
|
27
|
+
}
|
|
28
|
+
export type HostDomainField = 'subdomain' | 'cname' | 'cnameTwin';
|
|
29
|
+
export type PlatformServedVerdict = {
|
|
30
|
+
served: true;
|
|
31
|
+
via: 'subdomain' | 'cname' | 'twin';
|
|
32
|
+
hostId: string;
|
|
33
|
+
} | {
|
|
34
|
+
served: false;
|
|
35
|
+
reason:
|
|
36
|
+
/** Not a hostname at all, or the tenant apex itself. */
|
|
37
|
+
'not-a-hostname'
|
|
38
|
+
/** No host carries the name. */
|
|
39
|
+
| 'no-host'
|
|
40
|
+
/** More than one host carries the name; connect-time uniqueness failed. */
|
|
41
|
+
| 'ambiguous'
|
|
42
|
+
/** A host carries it, but its attach, detach or twin never landed. */
|
|
43
|
+
| 'not-live'
|
|
44
|
+
/** The hosting platform does not say the name serves on our deployment now. */
|
|
45
|
+
| 'not-serving'
|
|
46
|
+
/** A read failed. */
|
|
47
|
+
| 'error';
|
|
48
|
+
};
|
|
49
|
+
export interface PlatformServedDeps {
|
|
50
|
+
/** At most two hosts whose `field` equals `value`. */
|
|
51
|
+
findHosts?: (field: HostDomainField, value: string) => Promise<HostDomainRecord[]>;
|
|
52
|
+
/** The hosting platform's live view of a name on the tenant deployment. */
|
|
53
|
+
domainStatus?: (hostname: string) => Promise<ProjectDomainStatus>;
|
|
54
|
+
}
|
|
55
|
+
/** A request's hostname, lowercased and without a trailing dot; null for anything else. */
|
|
56
|
+
export declare function normalizeServedHostname(input: string): string | null;
|
|
57
|
+
/** Whether a name serves on our deployment, and why not when it does not. Never throws. */
|
|
58
|
+
export declare function platformServedDomain(hostname: string, deps?: PlatformServedDeps): Promise<PlatformServedVerdict>;
|
|
59
|
+
/** {@link platformServedDomain} as a yes or no. */
|
|
60
|
+
export declare function isPlatformServedDomain(hostname: string, deps?: PlatformServedDeps): Promise<boolean>;
|
|
@@ -0,0 +1,146 @@
|
|
|
1
|
+
import { _ as _extends } from "@swc/helpers/_/_extends";
|
|
2
|
+
/**
|
|
3
|
+
* @license
|
|
4
|
+
* Copyright 2026 Aglyn LLC
|
|
5
|
+
*
|
|
6
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
7
|
+
* you may not use this file except in compliance with the License.
|
|
8
|
+
* You may obtain a copy of the License at
|
|
9
|
+
*
|
|
10
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
11
|
+
*
|
|
12
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
13
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
14
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
15
|
+
* See the License for the specific language governing permissions and
|
|
16
|
+
* limitations under the License.
|
|
17
|
+
*/ import { liveCustomDomain, TENANT_APEX } from "@aglyn/aglyn/app-utils/host-naming";
|
|
18
|
+
import firebaseAdmin from "./firebase-admin.js";
|
|
19
|
+
import { PLATFORM_DOMAIN_PATTERN, MAX_DOMAIN_LENGTH } from "./platform-domain-names.js";
|
|
20
|
+
import { projectDomainStatus } from "./workspace-domains.js";
|
|
21
|
+
const HOST_DOMAIN_FIELDS = [
|
|
22
|
+
'subdomain',
|
|
23
|
+
'cname',
|
|
24
|
+
'cnameTwin',
|
|
25
|
+
'cnameAttachmentPending',
|
|
26
|
+
'cnameDetachmentPending',
|
|
27
|
+
'cnameTwinPending'
|
|
28
|
+
];
|
|
29
|
+
async function findHostsInFirestore(field, value) {
|
|
30
|
+
const snapshot = await firebaseAdmin.app().firestore().collection('hosts').where(field, '==', value).select(...HOST_DOMAIN_FIELDS).limit(2).get();
|
|
31
|
+
return snapshot.docs.map((doc)=>{
|
|
32
|
+
const data = doc.data();
|
|
33
|
+
return _extends({}, data, {
|
|
34
|
+
id: doc.id
|
|
35
|
+
});
|
|
36
|
+
});
|
|
37
|
+
}
|
|
38
|
+
/** A request's hostname, lowercased and without a trailing dot; null for anything else. */ export function normalizeServedHostname(input) {
|
|
39
|
+
const name = String(input != null ? input : '').trim().toLowerCase().replace(/\.+$/, '');
|
|
40
|
+
if (!name || name.length > MAX_DOMAIN_LENGTH) return null;
|
|
41
|
+
if (!PLATFORM_DOMAIN_PATTERN.test(name)) return null;
|
|
42
|
+
return name;
|
|
43
|
+
}
|
|
44
|
+
/** Whether a name serves on our deployment, and why not when it does not. Never throws. */ export async function platformServedDomain(hostname, deps = {}) {
|
|
45
|
+
var _deps_findHosts, _deps_domainStatus;
|
|
46
|
+
const name = normalizeServedHostname(hostname);
|
|
47
|
+
if (!name || name === TENANT_APEX) return {
|
|
48
|
+
served: false,
|
|
49
|
+
reason: 'not-a-hostname'
|
|
50
|
+
};
|
|
51
|
+
const findHosts = (_deps_findHosts = deps.findHosts) != null ? _deps_findHosts : findHostsInFirestore;
|
|
52
|
+
const domainStatus = (_deps_domainStatus = deps.domainStatus) != null ? _deps_domainStatus : (host)=>projectDomainStatus(host, {
|
|
53
|
+
scope: 'tenant'
|
|
54
|
+
});
|
|
55
|
+
try {
|
|
56
|
+
// A platform subdomain: one label under the apex, held by exactly one host.
|
|
57
|
+
if (name.endsWith(`.${TENANT_APEX}`)) {
|
|
58
|
+
const sub = name.slice(0, -(TENANT_APEX.length + 1));
|
|
59
|
+
if (!sub || sub.includes('.')) return {
|
|
60
|
+
served: false,
|
|
61
|
+
reason: 'no-host'
|
|
62
|
+
};
|
|
63
|
+
const hosts = (await findHosts('subdomain', sub)).filter((host)=>host.subdomain === sub);
|
|
64
|
+
if (hosts.length === 0) return {
|
|
65
|
+
served: false,
|
|
66
|
+
reason: 'no-host'
|
|
67
|
+
};
|
|
68
|
+
if (hosts.length > 1) return {
|
|
69
|
+
served: false,
|
|
70
|
+
reason: 'ambiguous'
|
|
71
|
+
};
|
|
72
|
+
return {
|
|
73
|
+
served: true,
|
|
74
|
+
via: 'subdomain',
|
|
75
|
+
hostId: hosts[0].id
|
|
76
|
+
};
|
|
77
|
+
}
|
|
78
|
+
// A custom domain: the host's own name, else the twin that forwards to it.
|
|
79
|
+
let match = null;
|
|
80
|
+
const byCname = (await findHosts('cname', name)).filter((host)=>{
|
|
81
|
+
var _host_cname;
|
|
82
|
+
return String((_host_cname = host.cname) != null ? _host_cname : '').trim().toLowerCase() === name;
|
|
83
|
+
});
|
|
84
|
+
if (byCname.length > 1) return {
|
|
85
|
+
served: false,
|
|
86
|
+
reason: 'ambiguous'
|
|
87
|
+
};
|
|
88
|
+
if (byCname.length === 1) match = {
|
|
89
|
+
host: byCname[0],
|
|
90
|
+
via: 'cname'
|
|
91
|
+
};
|
|
92
|
+
if (!match) {
|
|
93
|
+
const byTwin = (await findHosts('cnameTwin', name)).filter((host)=>{
|
|
94
|
+
var _host_cnameTwin;
|
|
95
|
+
return String((_host_cnameTwin = host.cnameTwin) != null ? _host_cnameTwin : '').trim().toLowerCase() === name;
|
|
96
|
+
});
|
|
97
|
+
if (byTwin.length > 1) return {
|
|
98
|
+
served: false,
|
|
99
|
+
reason: 'ambiguous'
|
|
100
|
+
};
|
|
101
|
+
if (byTwin.length === 1) match = {
|
|
102
|
+
host: byTwin[0],
|
|
103
|
+
via: 'twin'
|
|
104
|
+
};
|
|
105
|
+
}
|
|
106
|
+
if (!match) return {
|
|
107
|
+
served: false,
|
|
108
|
+
reason: 'no-host'
|
|
109
|
+
};
|
|
110
|
+
const primary = liveCustomDomain(match.host);
|
|
111
|
+
if (!primary) return {
|
|
112
|
+
served: false,
|
|
113
|
+
reason: 'not-live'
|
|
114
|
+
};
|
|
115
|
+
if (match.via === 'cname' && primary !== name) return {
|
|
116
|
+
served: false,
|
|
117
|
+
reason: 'not-live'
|
|
118
|
+
};
|
|
119
|
+
if (match.via === 'twin' && match.host.cnameTwinPending === true) return {
|
|
120
|
+
served: false,
|
|
121
|
+
reason: 'not-live'
|
|
122
|
+
};
|
|
123
|
+
const status = await domainStatus(name);
|
|
124
|
+
const conflicts = Array.isArray(status == null ? void 0 : status.conflicts) ? status.conflicts : [];
|
|
125
|
+
if ((status == null ? void 0 : status.state) !== 'serving' || conflicts.length > 0) return {
|
|
126
|
+
served: false,
|
|
127
|
+
reason: 'not-serving'
|
|
128
|
+
};
|
|
129
|
+
return {
|
|
130
|
+
served: true,
|
|
131
|
+
via: match.via,
|
|
132
|
+
hostId: match.host.id
|
|
133
|
+
};
|
|
134
|
+
} catch (error) {
|
|
135
|
+
console.error('[platform-served-domain] could not decide; answering no', name, error);
|
|
136
|
+
return {
|
|
137
|
+
served: false,
|
|
138
|
+
reason: 'error'
|
|
139
|
+
};
|
|
140
|
+
}
|
|
141
|
+
}
|
|
142
|
+
/** {@link platformServedDomain} as a yes or no. */ export async function isPlatformServedDomain(hostname, deps = {}) {
|
|
143
|
+
return (await platformServedDomain(hostname, deps)).served;
|
|
144
|
+
}
|
|
145
|
+
|
|
146
|
+
//# sourceMappingURL=platform-served-domain.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../../../../../../../../libs/tenant/data/admin/src/lib/server/platform-served-domain.ts"],"sourcesContent":["/**\n * @license\n * Copyright 2026 Aglyn LLC\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { liveCustomDomain, TENANT_APEX } from '@aglyn/aglyn/app-utils/host-naming'\nimport type { ProjectDomainStatus } from './domain-provider'\nimport firebaseAdmin from './firebase-admin'\nimport { PLATFORM_DOMAIN_PATTERN, MAX_DOMAIN_LENGTH } from './platform-domain-names'\nimport { projectDomainStatus } from './workspace-domains'\n\n/*==========================================\n * WHETHER THIS PLATFORM SERVES A HOSTNAME (AGL-4085).\n *\n * The question a caller asks before it hands a request a secret that only\n * our own edge may see: the site-import crawler's edge secret\n * (`site-import-edge.ts` in the AI plugin), which lifts the tenant's bot\n * challenge for AglynBot. A wrong \"yes\" sends that\n * secret to a stranger, so this answers from our own records and from the\n * hosting platform's live view, never from the shape of the name:\n *\n * - `{sub}.{TENANT_APEX}` is ours only when exactly one host carries that\n * `subdomain`. The apex's DNS is ours, so no one else can answer for it.\n * - Any other name is ours only when exactly one host carries it as its\n * `cname` (and `liveCustomDomain` says it serves: no attach or detach left\n * pending), or as its `cnameTwin` with the twin's redirect landed. That is\n * what the tenant's own `get-host.ts` resolves a request by.\n * - AND the hosting platform says, right now, that the name is attached to\n * the tenant deployment, verified, pointed at it with no foreign record\n * answering beside ours, and holding a certificate (`state: 'serving'`,\n * no `conflicts`). A customer's DNS was checked once, when they connected\n * the name; a name re-pointed since at a server of their own still reads\n * as live in Firestore, and only this read sees it.\n *\n * Every doubt is a \"no\": a query that fails, two hosts claiming one name, a\n * status the platform could not answer (`unknown`), a deployment with no\n * domain provider (`skipped`). A \"no\" costs only the challenge the crawler\n * met before this existed.\n *\n * What it cannot see: DNS that changes between this read and the request a\n * moment later. The secret that window could expose lifts the bot challenge\n * and nothing else (no sign-in, no lockdown, no rate limit), and the edge\n * rule asks for the AglynBot user agent as well.\n *=========================================*/\n\n/** The host fields a domain decision reads, and nothing else. */\nexport interface HostDomainRecord {\n id: string\n subdomain?: string | null\n cname?: string | null\n cnameTwin?: string | null\n cnameAttachmentPending?: boolean | null\n cnameDetachmentPending?: boolean | null\n cnameTwinPending?: boolean | null\n}\n\nexport type HostDomainField = 'subdomain' | 'cname' | 'cnameTwin'\n\nexport type PlatformServedVerdict =\n | { served: true; via: 'subdomain' | 'cname' | 'twin'; hostId: string }\n | {\n served: false\n reason:\n /** Not a hostname at all, or the tenant apex itself. */\n | 'not-a-hostname'\n /** No host carries the name. */\n | 'no-host'\n /** More than one host carries the name; connect-time uniqueness failed. */\n | 'ambiguous'\n /** A host carries it, but its attach, detach or twin never landed. */\n | 'not-live'\n /** The hosting platform does not say the name serves on our deployment now. */\n | 'not-serving'\n /** A read failed. */\n | 'error'\n }\n\nexport interface PlatformServedDeps {\n /** At most two hosts whose `field` equals `value`. */\n findHosts?: (field: HostDomainField, value: string) => Promise<HostDomainRecord[]>\n /** The hosting platform's live view of a name on the tenant deployment. */\n domainStatus?: (hostname: string) => Promise<ProjectDomainStatus>\n}\n\nconst HOST_DOMAIN_FIELDS = [\n 'subdomain',\n 'cname',\n 'cnameTwin',\n 'cnameAttachmentPending',\n 'cnameDetachmentPending',\n 'cnameTwinPending',\n] as const\n\nasync function findHostsInFirestore(field: HostDomainField, value: string): Promise<HostDomainRecord[]> {\n const snapshot = await firebaseAdmin\n .app()\n .firestore()\n .collection('hosts')\n .where(field, '==', value)\n .select(...HOST_DOMAIN_FIELDS)\n .limit(2)\n .get()\n return snapshot.docs.map((doc) => {\n const data = doc.data() as Omit<HostDomainRecord, 'id'>\n return { ...data, id: doc.id }\n })\n}\n\n/** A request's hostname, lowercased and without a trailing dot; null for anything else. */\nexport function normalizeServedHostname(input: string): string | null {\n const name = String(input ?? '').trim().toLowerCase().replace(/\\.+$/, '')\n if (!name || name.length > MAX_DOMAIN_LENGTH) return null\n if (!PLATFORM_DOMAIN_PATTERN.test(name)) return null\n return name\n}\n\n/** Whether a name serves on our deployment, and why not when it does not. Never throws. */\nexport async function platformServedDomain(\n hostname: string,\n deps: PlatformServedDeps = {},\n): Promise<PlatformServedVerdict> {\n const name = normalizeServedHostname(hostname)\n if (!name || name === TENANT_APEX) return { served: false, reason: 'not-a-hostname' }\n const findHosts = deps.findHosts ?? findHostsInFirestore\n const domainStatus = deps.domainStatus ?? ((host: string) => projectDomainStatus(host, { scope: 'tenant' }))\n\n try {\n // A platform subdomain: one label under the apex, held by exactly one host.\n if (name.endsWith(`.${TENANT_APEX}`)) {\n const sub = name.slice(0, -(TENANT_APEX.length + 1))\n if (!sub || sub.includes('.')) return { served: false, reason: 'no-host' }\n const hosts = (await findHosts('subdomain', sub)).filter((host) => host.subdomain === sub)\n if (hosts.length === 0) return { served: false, reason: 'no-host' }\n if (hosts.length > 1) return { served: false, reason: 'ambiguous' }\n return { served: true, via: 'subdomain', hostId: hosts[0].id }\n }\n\n // A custom domain: the host's own name, else the twin that forwards to it.\n let match: { host: HostDomainRecord; via: 'cname' | 'twin' } | null = null\n const byCname = (await findHosts('cname', name)).filter(\n (host) => String(host.cname ?? '').trim().toLowerCase() === name,\n )\n if (byCname.length > 1) return { served: false, reason: 'ambiguous' }\n if (byCname.length === 1) match = { host: byCname[0], via: 'cname' }\n if (!match) {\n const byTwin = (await findHosts('cnameTwin', name)).filter(\n (host) => String(host.cnameTwin ?? '').trim().toLowerCase() === name,\n )\n if (byTwin.length > 1) return { served: false, reason: 'ambiguous' }\n if (byTwin.length === 1) match = { host: byTwin[0], via: 'twin' }\n }\n if (!match) return { served: false, reason: 'no-host' }\n\n const primary = liveCustomDomain(match.host)\n if (!primary) return { served: false, reason: 'not-live' }\n if (match.via === 'cname' && primary !== name) return { served: false, reason: 'not-live' }\n if (match.via === 'twin' && match.host.cnameTwinPending === true) return { served: false, reason: 'not-live' }\n\n const status = await domainStatus(name)\n const conflicts = Array.isArray(status?.conflicts) ? status.conflicts : []\n if (status?.state !== 'serving' || conflicts.length > 0) return { served: false, reason: 'not-serving' }\n return { served: true, via: match.via, hostId: match.host.id }\n } catch (error) {\n console.error('[platform-served-domain] could not decide; answering no', name, error)\n return { served: false, reason: 'error' }\n }\n}\n\n/** {@link platformServedDomain} as a yes or no. */\nexport async function isPlatformServedDomain(hostname: string, deps: PlatformServedDeps = {}): Promise<boolean> {\n return (await platformServedDomain(hostname, deps)).served\n}\n"],"names":["liveCustomDomain","TENANT_APEX","firebaseAdmin","PLATFORM_DOMAIN_PATTERN","MAX_DOMAIN_LENGTH","projectDomainStatus","HOST_DOMAIN_FIELDS","findHostsInFirestore","field","value","snapshot","app","firestore","collection","where","select","limit","get","docs","map","doc","data","id","normalizeServedHostname","input","name","String","trim","toLowerCase","replace","length","test","platformServedDomain","hostname","deps","served","reason","findHosts","domainStatus","host","scope","endsWith","sub","slice","includes","hosts","filter","subdomain","via","hostId","match","byCname","cname","byTwin","cnameTwin","primary","cnameTwinPending","status","conflicts","Array","isArray","state","error","console","isPlatformServedDomain"],"mappings":";AAAA;;;;;;;;;;;;;;;CAeC,GAED,SAASA,gBAAgB,EAAEC,WAAW,QAAQ,qCAAoC;AAElF,OAAOC,mBAAmB,sBAAkB;AAC5C,SAASC,uBAAuB,EAAEC,iBAAiB,QAAQ,6BAAyB;AACpF,SAASC,mBAAmB,QAAQ,yBAAqB;AA2EzD,MAAMC,qBAAqB;IACzB;IACA;IACA;IACA;IACA;IACA;CACD;AAED,eAAeC,qBAAqBC,KAAsB,EAAEC,KAAa;IACvE,MAAMC,WAAW,MAAMR,cACpBS,GAAG,GACHC,SAAS,GACTC,UAAU,CAAC,SACXC,KAAK,CAACN,OAAO,MAAMC,OACnBM,MAAM,IAAIT,oBACVU,KAAK,CAAC,GACNC,GAAG;IACN,OAAOP,SAASQ,IAAI,CAACC,GAAG,CAAC,CAACC;QACxB,MAAMC,OAAOD,IAAIC,IAAI;QACrB,OAAO,aAAKA;YAAMC,IAAIF,IAAIE,EAAE;;IAC9B;AACF;AAEA,yFAAyF,GACzF,OAAO,SAASC,wBAAwBC,KAAa;IACnD,MAAMC,OAAOC,OAAOF,gBAAAA,QAAS,IAAIG,IAAI,GAAGC,WAAW,GAAGC,OAAO,CAAC,QAAQ;IACtE,IAAI,CAACJ,QAAQA,KAAKK,MAAM,GAAG1B,mBAAmB,OAAO;IACrD,IAAI,CAACD,wBAAwB4B,IAAI,CAACN,OAAO,OAAO;IAChD,OAAOA;AACT;AAEA,yFAAyF,GACzF,OAAO,eAAeO,qBACpBC,QAAgB,EAChBC,OAA2B,CAAC,CAAC;QAIXA,iBACGA;IAHrB,MAAMT,OAAOF,wBAAwBU;IACrC,IAAI,CAACR,QAAQA,SAASxB,aAAa,OAAO;QAAEkC,QAAQ;QAAOC,QAAQ;IAAiB;IACpF,MAAMC,aAAYH,kBAAAA,KAAKG,SAAS,YAAdH,kBAAkB3B;IACpC,MAAM+B,gBAAeJ,qBAAAA,KAAKI,YAAY,YAAjBJ,qBAAsB,CAACK,OAAiBlC,oBAAoBkC,MAAM;YAAEC,OAAO;QAAS;IAEzG,IAAI;QACF,4EAA4E;QAC5E,IAAIf,KAAKgB,QAAQ,CAAC,CAAC,CAAC,EAAExC,aAAa,GAAG;YACpC,MAAMyC,MAAMjB,KAAKkB,KAAK,CAAC,GAAG,CAAE1C,CAAAA,YAAY6B,MAAM,GAAG,CAAA;YACjD,IAAI,CAACY,OAAOA,IAAIE,QAAQ,CAAC,MAAM,OAAO;gBAAET,QAAQ;gBAAOC,QAAQ;YAAU;YACzE,MAAMS,QAAQ,AAAC,CAAA,MAAMR,UAAU,aAAaK,IAAG,EAAGI,MAAM,CAAC,CAACP,OAASA,KAAKQ,SAAS,KAAKL;YACtF,IAAIG,MAAMf,MAAM,KAAK,GAAG,OAAO;gBAAEK,QAAQ;gBAAOC,QAAQ;YAAU;YAClE,IAAIS,MAAMf,MAAM,GAAG,GAAG,OAAO;gBAAEK,QAAQ;gBAAOC,QAAQ;YAAY;YAClE,OAAO;gBAAED,QAAQ;gBAAMa,KAAK;gBAAaC,QAAQJ,KAAK,CAAC,EAAE,CAACvB,EAAE;YAAC;QAC/D;QAEA,2EAA2E;QAC3E,IAAI4B,QAAkE;QACtE,MAAMC,UAAU,AAAC,CAAA,MAAMd,UAAU,SAASZ,KAAI,EAAGqB,MAAM,CACrD,CAACP;gBAAgBA;mBAAPb,QAAOa,cAAAA,KAAKa,KAAK,YAAVb,cAAc,IAAIZ,IAAI,GAAGC,WAAW,OAAOH;;QAE9D,IAAI0B,QAAQrB,MAAM,GAAG,GAAG,OAAO;YAAEK,QAAQ;YAAOC,QAAQ;QAAY;QACpE,IAAIe,QAAQrB,MAAM,KAAK,GAAGoB,QAAQ;YAAEX,MAAMY,OAAO,CAAC,EAAE;YAAEH,KAAK;QAAQ;QACnE,IAAI,CAACE,OAAO;YACV,MAAMG,SAAS,AAAC,CAAA,MAAMhB,UAAU,aAAaZ,KAAI,EAAGqB,MAAM,CACxD,CAACP;oBAAgBA;uBAAPb,QAAOa,kBAAAA,KAAKe,SAAS,YAAdf,kBAAkB,IAAIZ,IAAI,GAAGC,WAAW,OAAOH;;YAElE,IAAI4B,OAAOvB,MAAM,GAAG,GAAG,OAAO;gBAAEK,QAAQ;gBAAOC,QAAQ;YAAY;YACnE,IAAIiB,OAAOvB,MAAM,KAAK,GAAGoB,QAAQ;gBAAEX,MAAMc,MAAM,CAAC,EAAE;gBAAEL,KAAK;YAAO;QAClE;QACA,IAAI,CAACE,OAAO,OAAO;YAAEf,QAAQ;YAAOC,QAAQ;QAAU;QAEtD,MAAMmB,UAAUvD,iBAAiBkD,MAAMX,IAAI;QAC3C,IAAI,CAACgB,SAAS,OAAO;YAAEpB,QAAQ;YAAOC,QAAQ;QAAW;QACzD,IAAIc,MAAMF,GAAG,KAAK,WAAWO,YAAY9B,MAAM,OAAO;YAAEU,QAAQ;YAAOC,QAAQ;QAAW;QAC1F,IAAIc,MAAMF,GAAG,KAAK,UAAUE,MAAMX,IAAI,CAACiB,gBAAgB,KAAK,MAAM,OAAO;YAAErB,QAAQ;YAAOC,QAAQ;QAAW;QAE7G,MAAMqB,SAAS,MAAMnB,aAAab;QAClC,MAAMiC,YAAYC,MAAMC,OAAO,CAACH,0BAAAA,OAAQC,SAAS,IAAID,OAAOC,SAAS,GAAG,EAAE;QAC1E,IAAID,CAAAA,0BAAAA,OAAQI,KAAK,MAAK,aAAaH,UAAU5B,MAAM,GAAG,GAAG,OAAO;YAAEK,QAAQ;YAAOC,QAAQ;QAAc;QACvG,OAAO;YAAED,QAAQ;YAAMa,KAAKE,MAAMF,GAAG;YAAEC,QAAQC,MAAMX,IAAI,CAACjB,EAAE;QAAC;IAC/D,EAAE,OAAOwC,OAAO;QACdC,QAAQD,KAAK,CAAC,2DAA2DrC,MAAMqC;QAC/E,OAAO;YAAE3B,QAAQ;YAAOC,QAAQ;QAAQ;IAC1C;AACF;AAEA,iDAAiD,GACjD,OAAO,eAAe4B,uBAAuB/B,QAAgB,EAAEC,OAA2B,CAAC,CAAC;IAC1F,OAAO,AAAC,CAAA,MAAMF,qBAAqBC,UAAUC,KAAI,EAAGC,MAAM;AAC5D"}
|
|
@@ -0,0 +1,169 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @license
|
|
3
|
+
* Copyright 2026 Aglyn LLC
|
|
4
|
+
*
|
|
5
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
+
* you may not use this file except in compliance with the License.
|
|
7
|
+
* You may obtain a copy of the License at
|
|
8
|
+
*
|
|
9
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
*
|
|
11
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
12
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
+
* See the License for the specific language governing permissions and
|
|
15
|
+
* limitations under the License.
|
|
16
|
+
*/
|
|
17
|
+
import type { Writable } from 'node:stream';
|
|
18
|
+
import { type VisitorUploadFile, type VisitorUploadKind, type VisitorUploadScope } from '@aglyn/aglyn/app-utils/visitor-upload';
|
|
19
|
+
/** The few Storage calls this makes, so a spec can stand in for the bucket. */
|
|
20
|
+
export interface VisitorUploadObject {
|
|
21
|
+
generateSignedPostPolicyV4(options: {
|
|
22
|
+
expires: number;
|
|
23
|
+
conditions?: unknown[];
|
|
24
|
+
fields?: Record<string, string>;
|
|
25
|
+
}): Promise<[{
|
|
26
|
+
url: string;
|
|
27
|
+
fields: Record<string, string>;
|
|
28
|
+
}] | Array<{
|
|
29
|
+
url: string;
|
|
30
|
+
fields: Record<string, string>;
|
|
31
|
+
}>>;
|
|
32
|
+
exists(): Promise<[boolean] | boolean[]>;
|
|
33
|
+
getMetadata(): Promise<[VisitorUploadObjectMetadata] | VisitorUploadObjectMetadata[]>;
|
|
34
|
+
download(options?: {
|
|
35
|
+
start?: number;
|
|
36
|
+
end?: number;
|
|
37
|
+
}): Promise<[Buffer] | Buffer[]>;
|
|
38
|
+
save(data: Buffer, options: Record<string, unknown>): Promise<unknown>;
|
|
39
|
+
move(destination: string): Promise<unknown>;
|
|
40
|
+
setMetadata(metadata: Record<string, unknown>): Promise<unknown>;
|
|
41
|
+
delete(options?: {
|
|
42
|
+
ignoreNotFound?: boolean;
|
|
43
|
+
}): Promise<unknown>;
|
|
44
|
+
createReadStream(): NodeJS.ReadableStream;
|
|
45
|
+
}
|
|
46
|
+
export interface VisitorUploadObjectMetadata {
|
|
47
|
+
size?: string | number;
|
|
48
|
+
contentType?: string;
|
|
49
|
+
metadata?: Record<string, string | null | undefined> | null;
|
|
50
|
+
}
|
|
51
|
+
export interface VisitorUploadBucket {
|
|
52
|
+
file(path: string): VisitorUploadObject;
|
|
53
|
+
deleteFiles(options: {
|
|
54
|
+
prefix: string;
|
|
55
|
+
}): Promise<unknown>;
|
|
56
|
+
}
|
|
57
|
+
export interface VisitorUploadDeps {
|
|
58
|
+
bucket(): VisitorUploadBucket;
|
|
59
|
+
consumeRateLimit(key: string, options: {
|
|
60
|
+
limit: number;
|
|
61
|
+
windowMs: number;
|
|
62
|
+
}): Promise<{
|
|
63
|
+
allowed: boolean;
|
|
64
|
+
resetMs: number;
|
|
65
|
+
}>;
|
|
66
|
+
/** Whether the platform's uploads pause (`uploads` lockdown feature) is on. */
|
|
67
|
+
uploadsPaused(): Promise<boolean>;
|
|
68
|
+
/** The secret tickets are signed with. Throws when none is configured. */
|
|
69
|
+
secret(): string;
|
|
70
|
+
now(): number;
|
|
71
|
+
/** A fresh upload id: a path segment no one can guess. */
|
|
72
|
+
newId(): string;
|
|
73
|
+
}
|
|
74
|
+
export declare function defaultVisitorUploadDeps(): VisitorUploadDeps;
|
|
75
|
+
/** One rate limit: so many in so long. */
|
|
76
|
+
export interface VisitorUploadRate {
|
|
77
|
+
limit: number;
|
|
78
|
+
windowMs: number;
|
|
79
|
+
}
|
|
80
|
+
/** The limits a ticket spends, per caller on a site and per site. */
|
|
81
|
+
export interface VisitorUploadLimits {
|
|
82
|
+
perCaller: VisitorUploadRate;
|
|
83
|
+
perSite: VisitorUploadRate;
|
|
84
|
+
}
|
|
85
|
+
/**
|
|
86
|
+
* Tickets per caller on one site: 30 in ten minutes is three full
|
|
87
|
+
* submissions of ten files; per site, 300 an hour across everyone.
|
|
88
|
+
*/
|
|
89
|
+
export declare const VISITOR_UPLOAD_LIMITS: VisitorUploadLimits;
|
|
90
|
+
/** Finalizes per caller on one site, per ten minutes: a retry or two per ticket. */
|
|
91
|
+
export declare const VISITOR_UPLOAD_FINALIZE_LIMIT: VisitorUploadRate;
|
|
92
|
+
/** How long after its upload lapses a ticket may still be finalized: a slow connection's last bytes. */
|
|
93
|
+
export declare const VISITOR_UPLOAD_FINALIZE_GRACE_MS: number;
|
|
94
|
+
/** Who is uploading: an address for a visitor, a uid for a member. Keys the per-caller limit. */
|
|
95
|
+
export type VisitorUploadCaller = {
|
|
96
|
+
ip: string;
|
|
97
|
+
} | {
|
|
98
|
+
uid: string;
|
|
99
|
+
};
|
|
100
|
+
export type VisitorUploadRefusal = {
|
|
101
|
+
ok: false;
|
|
102
|
+
status: number;
|
|
103
|
+
error: string;
|
|
104
|
+
code: 'type' | 'size' | 'empty' | 'scope' | 'rate' | 'paused' | 'ticket' | 'missing' | 'inspection' | 'unchecked';
|
|
105
|
+
retryAfterSeconds?: number;
|
|
106
|
+
};
|
|
107
|
+
export interface VisitorUploadTicket {
|
|
108
|
+
ok: true;
|
|
109
|
+
/** Handed back to finalize. */
|
|
110
|
+
ticket: string;
|
|
111
|
+
/** The signed form post: where, and the fields that go before the file. */
|
|
112
|
+
upload: {
|
|
113
|
+
url: string;
|
|
114
|
+
fields: Record<string, string>;
|
|
115
|
+
};
|
|
116
|
+
/** The file as it will be kept. */
|
|
117
|
+
file: {
|
|
118
|
+
id: string;
|
|
119
|
+
name: string;
|
|
120
|
+
contentType: string;
|
|
121
|
+
size: number;
|
|
122
|
+
};
|
|
123
|
+
}
|
|
124
|
+
/**
|
|
125
|
+
* A ticket and a signed upload for ONE file, after the caller's route has
|
|
126
|
+
* decided the caller may upload for `scope`. Spends the rate limits; refused
|
|
127
|
+
* while the platform's uploads are paused. `maxBytes` narrows the 25 MB
|
|
128
|
+
* ceiling, never widens it; `kinds` narrows the types taken (a form field
|
|
129
|
+
* that asks for PDFs only), never widens them.
|
|
130
|
+
*/
|
|
131
|
+
export declare function mintVisitorUploadTicket(deps: VisitorUploadDeps, input: {
|
|
132
|
+
scope: VisitorUploadScope;
|
|
133
|
+
request: unknown;
|
|
134
|
+
caller: VisitorUploadCaller;
|
|
135
|
+
limits?: VisitorUploadLimits;
|
|
136
|
+
maxBytes?: number;
|
|
137
|
+
kinds?: readonly VisitorUploadKind[];
|
|
138
|
+
}): Promise<VisitorUploadTicket | VisitorUploadRefusal>;
|
|
139
|
+
/**
|
|
140
|
+
* Checks and keeps the file a ticket signed for. The ticket must be one this
|
|
141
|
+
* signed, for this `scope`, not long lapsed. Idempotent: a retried finalize
|
|
142
|
+
* of a file already kept answers its record.
|
|
143
|
+
*/
|
|
144
|
+
export declare function finalizeVisitorUpload(deps: VisitorUploadDeps, input: {
|
|
145
|
+
scope: VisitorUploadScope;
|
|
146
|
+
ticket: unknown;
|
|
147
|
+
caller: VisitorUploadCaller;
|
|
148
|
+
}): Promise<{
|
|
149
|
+
ok: true;
|
|
150
|
+
file: VisitorUploadFile;
|
|
151
|
+
} | VisitorUploadRefusal>;
|
|
152
|
+
/** A kept file's record, by its id within `scope`; null when there is none. */
|
|
153
|
+
export declare function readVisitorUpload(deps: Pick<VisitorUploadDeps, 'bucket'>, scope: VisitorUploadScope, id: string): Promise<VisitorUploadFile | null>;
|
|
154
|
+
/** Deletes one kept file. Gone already is fine. */
|
|
155
|
+
export declare function deleteVisitorUpload(deps: Pick<VisitorUploadDeps, 'bucket'>, path: string): Promise<void>;
|
|
156
|
+
/** Deletes every kept file of one purpose and record. */
|
|
157
|
+
export declare function deleteVisitorUploads(deps: Pick<VisitorUploadDeps, 'bucket'>, scope: VisitorUploadScope): Promise<void>;
|
|
158
|
+
/** The headers a kept file is served with. */
|
|
159
|
+
export declare function visitorUploadResponseHeaders(file: Pick<VisitorUploadFile, 'name' | 'contentType'>): Record<string, string>;
|
|
160
|
+
/** The response a gated route streams a kept file into. */
|
|
161
|
+
export interface VisitorUploadResponse extends Writable {
|
|
162
|
+
setHeader(name: string, value: string): void;
|
|
163
|
+
status(code: number): unknown;
|
|
164
|
+
}
|
|
165
|
+
/**
|
|
166
|
+
* Streams a kept file to a route's response, after the route has checked the
|
|
167
|
+
* caller. The file is never held whole in memory.
|
|
168
|
+
*/
|
|
169
|
+
export declare function sendVisitorUploadFile(deps: Pick<VisitorUploadDeps, 'bucket'>, res: VisitorUploadResponse, file: Pick<VisitorUploadFile, 'path' | 'name' | 'contentType'>): Promise<void>;
|