@aglyn/tenant-data-admin 1.0.0-beta.270 → 1.0.0-beta.272

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.
Files changed (58) hide show
  1. package/package.json +7 -7
  2. package/src/lib/server/append-only-history-write.d.ts +38 -0
  3. package/src/lib/server/append-only-history-write.js +60 -0
  4. package/src/lib/server/append-only-history-write.js.map +1 -0
  5. package/src/lib/server/billing-addons.d.ts +58 -32
  6. package/src/lib/server/billing-addons.js +100 -86
  7. package/src/lib/server/billing-addons.js.map +1 -1
  8. package/src/lib/server/bundle-links.d.ts +166 -0
  9. package/src/lib/server/bundle-links.js +286 -0
  10. package/src/lib/server/bundle-links.js.map +1 -0
  11. package/src/lib/server/client-build.d.ts +74 -0
  12. package/src/lib/server/client-build.js +264 -0
  13. package/src/lib/server/client-build.js.map +1 -0
  14. package/src/lib/server/domain-ownership.d.ts +205 -0
  15. package/src/lib/server/domain-ownership.js +575 -0
  16. package/src/lib/server/domain-ownership.js.map +1 -0
  17. package/src/lib/server/erase.d.ts +17 -0
  18. package/src/lib/server/erase.js +21 -0
  19. package/src/lib/server/erase.js.map +1 -1
  20. package/src/lib/server/host-memberships.d.ts +35 -2
  21. package/src/lib/server/host-memberships.js +63 -2
  22. package/src/lib/server/host-memberships.js.map +1 -1
  23. package/src/lib/server/org-billing.d.ts +4 -2
  24. package/src/lib/server/org-billing.js +5 -0
  25. package/src/lib/server/org-billing.js.map +1 -1
  26. package/src/lib/server/site-care-emails.d.ts +53 -0
  27. package/src/lib/server/site-care-emails.js +97 -0
  28. package/src/lib/server/site-care-emails.js.map +1 -0
  29. package/src/lib/server/site-care-inbound.d.ts +123 -0
  30. package/src/lib/server/site-care-inbound.js +197 -0
  31. package/src/lib/server/site-care-inbound.js.map +1 -0
  32. package/src/lib/server/site-care-project-reconcile.d.ts +64 -0
  33. package/src/lib/server/site-care-project-reconcile.js +211 -0
  34. package/src/lib/server/site-care-project-reconcile.js.map +1 -0
  35. package/src/lib/server/site-care-project-stripe.d.ts +114 -0
  36. package/src/lib/server/site-care-project-stripe.js +305 -0
  37. package/src/lib/server/site-care-project-stripe.js.map +1 -0
  38. package/src/lib/server/site-care-projects.d.ts +169 -0
  39. package/src/lib/server/site-care-projects.js +882 -0
  40. package/src/lib/server/site-care-projects.js.map +1 -0
  41. package/src/lib/server/site-care-reconcile.d.ts +81 -0
  42. package/src/lib/server/site-care-reconcile.js +349 -0
  43. package/src/lib/server/site-care-reconcile.js.map +1 -0
  44. package/src/lib/server/site-care-requests.d.ts +243 -0
  45. package/src/lib/server/site-care-requests.js +1414 -0
  46. package/src/lib/server/site-care-requests.js.map +1 -0
  47. package/src/lib/server/site-care-stripe.d.ts +175 -0
  48. package/src/lib/server/site-care-stripe.js +375 -0
  49. package/src/lib/server/site-care-stripe.js.map +1 -0
  50. package/src/lib/server/sso-provisioning.d.ts +6 -0
  51. package/src/lib/server/sso-provisioning.js +7 -0
  52. package/src/lib/server/sso-provisioning.js.map +1 -1
  53. package/src/lib/server/upgrade-proposal.d.ts +40 -1
  54. package/src/lib/server/upgrade-proposal.js +92 -50
  55. package/src/lib/server/upgrade-proposal.js.map +1 -1
  56. package/src/tenancy.d.ts +1 -0
  57. package/src/tenancy.js +2 -0
  58. package/src/tenancy.js.map +1 -1
@@ -0,0 +1,264 @@
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 { CLIENT_BUILD_COLLECTION, CLIENT_BUILD_DOC_ID, clientBuildIntent, clientBuildPhone, clientBuildPreviewText, clientBuildSiteAddress, EMPTY_CLIENT_BUILD_INTAKE, parseClientBuildDomain, parseClientBuildIntake, readClientBuildIntent } from "@aglyn/aglyn/app-utils/client-build";
18
+ import { hostPublicOrigin } from "@aglyn/aglyn/app-utils/host-naming";
19
+ import { readOrgPlanComp } from "@aglyn/aglyn/app-utils/plan-entitlements";
20
+ import { PLATFORM_BRAND_NAME } from "@aglyn/aglyn/app-utils/platform-brand";
21
+ import { pluginSmsMessaging } from "@aglyn/aglyn/plugin-manager/plugin-sms-messaging";
22
+ import { isEmailConfigured, sendEmail } from "@aglyn/shared-util-email";
23
+ import { addAdminAudit } from "./admin-audit-write.js";
24
+ import { meterOrgEmail } from "./email-metering.js";
25
+ import firebaseAdmin from "./firebase-admin.js";
26
+ import { renderSystemEmailContent, systemEmailBrand } from "./render-system-email.js";
27
+ /**
28
+ * THE ONE-SCREEN BUILD FOR A CLIENT, ON THE SERVER (AGL-3958).
29
+ *
30
+ * One record per workspace, at `orgs/{orgId}/clientBuild/current`, which the
31
+ * rules open to no client: the owner's phone and email are staff's to hold
32
+ * until the owner joins, and the org document is read by every member. Only
33
+ * `/api/admin/client-build` (staff) calls this module.
34
+ */ const firestore = ()=>firebaseAdmin.app().firestore();
35
+ /** A refusal the route answers with its status. */ export class ClientBuildError extends Error {
36
+ constructor(message, status){
37
+ super(message), this.status = status;
38
+ this.name = 'ClientBuildError';
39
+ }
40
+ }
41
+ function recordRef(orgId) {
42
+ return firestore().collection('orgs').doc(orgId).collection(CLIENT_BUILD_COLLECTION).doc(CLIENT_BUILD_DOC_ID);
43
+ }
44
+ /** A stored record, read back defensively; `null` when the workspace has none. */ export function readClientBuildRecord(raw) {
45
+ var _time, _text;
46
+ if (!raw || typeof raw !== 'object') return null;
47
+ const source = raw;
48
+ const intake = parseClientBuildIntake(source['intake']);
49
+ const domain = source['domain'] ? parseClientBuildDomain(source['domain']) : null;
50
+ const intent = readClientBuildIntent(source['intent']);
51
+ const text = (value)=>typeof value === 'string' && value ? value : null;
52
+ const time = (value)=>typeof value === 'number' && Number.isFinite(value) ? value : null;
53
+ return {
54
+ // A stored intake that no longer validates is still the one staff typed.
55
+ intake: typeof intake === 'string' ? _extends({}, EMPTY_CLIENT_BUILD_INTAKE, source['intake']) : intake,
56
+ domain: typeof domain === 'string' ? null : domain,
57
+ intent: intent != null ? intent : clientBuildIntent({
58
+ plan: null,
59
+ domain: typeof domain === 'string' ? null : domain
60
+ }),
61
+ hostId: text(source['hostId']),
62
+ host: text(source['host']),
63
+ jobId: text(source['jobId']),
64
+ starter: source['starter'] === true,
65
+ previewSentAt: time(source['previewSentAt']),
66
+ updatedAt: (_time = time(source['updatedAt'])) != null ? _time : 0,
67
+ updatedBy: (_text = text(source['updatedBy'])) != null ? _text : ''
68
+ };
69
+ }
70
+ /** The workspace's build, or `null` before one was started. */ export async function loadClientBuild(orgId) {
71
+ const snapshot = await recordRef(orgId).get();
72
+ return snapshot.exists ? readClientBuildRecord(snapshot.data()) : null;
73
+ }
74
+ /**
75
+ * The intent the hand-off proposes (AGL-3955, AGL-3956): what the build left
76
+ * for the owner's checkout, or `null` when the workspace was not built here.
77
+ */ export async function loadClientBuildIntent(orgId) {
78
+ var _ref;
79
+ var _this;
80
+ return (_ref = (_this = await loadClientBuild(orgId)) == null ? void 0 : _this.intent) != null ? _ref : null;
81
+ }
82
+ const ID_PATTERN = /^[A-Za-z0-9_-]{1,128}$/;
83
+ /**
84
+ * Writes the build, merged over what is stored. The intake and the domain
85
+ * are validated as the screen validated them; the intent is derived, never
86
+ * taken from the body: the plan the workspace was comped on, Site Care, and
87
+ * the domain the Domain step recorded. A site is accepted only when it
88
+ * belongs to this workspace.
89
+ */ export async function saveClientBuild(options) {
90
+ var _ref, _ref1, _ref2, _ref3, _ref4, _ref5, _ref6, _ref7, _options_now;
91
+ var _readOrgPlanComp;
92
+ const { orgId, actorUid, patch } = options;
93
+ const org = await firestore().collection('orgs').doc(orgId).get();
94
+ if (!org.exists) throw new ClientBuildError('Unknown workspace', 404);
95
+ const stored = await loadClientBuild(orgId);
96
+ let intake = (_ref = stored == null ? void 0 : stored.intake) != null ? _ref : null;
97
+ if (patch.intake !== undefined) {
98
+ const parsed = parseClientBuildIntake(patch.intake);
99
+ if (typeof parsed === 'string') throw new ClientBuildError(parsed, 400);
100
+ intake = parsed;
101
+ }
102
+ if (!intake) throw new ClientBuildError('Missing the business details', 400);
103
+ let domain = (_ref1 = stored == null ? void 0 : stored.domain) != null ? _ref1 : null;
104
+ if (patch.domain !== undefined) {
105
+ if (patch.domain === null) domain = null;
106
+ else {
107
+ const parsed = parseClientBuildDomain(patch.domain);
108
+ if (typeof parsed === 'string') throw new ClientBuildError(parsed, 400);
109
+ domain = parsed;
110
+ }
111
+ }
112
+ let hostId = (_ref2 = stored == null ? void 0 : stored.hostId) != null ? _ref2 : null;
113
+ let host = (_ref3 = stored == null ? void 0 : stored.host) != null ? _ref3 : null;
114
+ if (patch.hostId !== undefined) {
115
+ var _patch_hostId;
116
+ const id = String((_patch_hostId = patch.hostId) != null ? _patch_hostId : '');
117
+ if (!ID_PATTERN.test(id)) throw new ClientBuildError('Unknown site', 400);
118
+ const site = await firestore().collection('hosts').doc(id).get();
119
+ if (!site.exists || site.get('orgId') !== orgId) {
120
+ throw new ClientBuildError('That site is not in this workspace', 400);
121
+ }
122
+ hostId = id;
123
+ host = typeof site.get('subdomain') === 'string' ? site.get('subdomain') : patch.host ? String(patch.host) : null;
124
+ }
125
+ let jobId = (_ref4 = stored == null ? void 0 : stored.jobId) != null ? _ref4 : null;
126
+ if (patch.jobId !== undefined) {
127
+ var _patch_jobId;
128
+ const id = String((_patch_jobId = patch.jobId) != null ? _patch_jobId : '');
129
+ if (!ID_PATTERN.test(id)) throw new ClientBuildError('Unknown job', 400);
130
+ jobId = id;
131
+ }
132
+ let starter = (_ref5 = stored == null ? void 0 : stored.starter) != null ? _ref5 : false;
133
+ if (patch.starter !== undefined) {
134
+ if (typeof patch.starter !== 'boolean') throw new ClientBuildError('Unknown starter choice', 400);
135
+ starter = patch.starter;
136
+ }
137
+ const record = {
138
+ intake,
139
+ domain,
140
+ // Derived on every write, never taken from the body: the plan the
141
+ // workspace was comped on, Site Care, monthly, and the domain above.
142
+ intent: clientBuildIntent({
143
+ plan: (_ref6 = (_readOrgPlanComp = readOrgPlanComp(org.data())) == null ? void 0 : _readOrgPlanComp.plan) != null ? _ref6 : null,
144
+ domain
145
+ }),
146
+ hostId,
147
+ host,
148
+ jobId,
149
+ starter,
150
+ previewSentAt: (_ref7 = stored == null ? void 0 : stored.previewSentAt) != null ? _ref7 : null,
151
+ updatedAt: (_options_now = options.now) != null ? _options_now : Date.now(),
152
+ updatedBy: actorUid
153
+ };
154
+ await recordRef(orgId).set(record);
155
+ return record;
156
+ }
157
+ /**
158
+ * Sends the owner the preview: a text and an email with the link to the site
159
+ * as it is now and the address it will live at. Only once the site has a
160
+ * published page, since the link would otherwise open an empty site. Each
161
+ * channel is attempted on its own and reported; the send is an Audit Log row.
162
+ */ export async function sendClientBuildPreview(options) {
163
+ var _site_screens, _site_subdomain, _options_now;
164
+ const { orgId, actorUid } = options;
165
+ const record = await loadClientBuild(orgId);
166
+ if (!(record == null ? void 0 : record.hostId)) throw new ClientBuildError('Build the site first', 409);
167
+ const [orgSnapshot, siteSnapshot] = await Promise.all([
168
+ firestore().collection('orgs').doc(orgId).get(),
169
+ firestore().collection('hosts').doc(record.hostId).get()
170
+ ]);
171
+ if (!siteSnapshot.exists || siteSnapshot.get('orgId') !== orgId) {
172
+ throw new ClientBuildError('That site is not in this workspace', 409);
173
+ }
174
+ const site = siteSnapshot.data();
175
+ if (!Object.keys((_site_screens = site.screens) != null ? _site_screens : {}).length) {
176
+ throw new ClientBuildError('The site has no published page yet', 409);
177
+ }
178
+ const previewUrl = hostPublicOrigin({
179
+ subdomain: (_site_subdomain = site.subdomain) != null ? _site_subdomain : null
180
+ });
181
+ if (!previewUrl) throw new ClientBuildError('The site has no address yet', 409);
182
+ const siteAddress = clientBuildSiteAddress(record.domain, previewUrl);
183
+ const { intake } = record;
184
+ const businessName = intake.businessName || 'your business';
185
+ const brand = systemEmailBrand(orgSnapshot.data());
186
+ const productName = brand.merge['brand.productName'] || PLATFORM_BRAND_NAME;
187
+ let emailed = false;
188
+ if (intake.email && isEmailConfigured()) {
189
+ try {
190
+ const content = await renderSystemEmailContent('client-build-preview', {
191
+ 'business.name': businessName,
192
+ 'preview.url': previewUrl,
193
+ 'site.address': siteAddress != null ? siteAddress : previewUrl
194
+ }, brand, {
195
+ subject: `Your new website for ${businessName} is ready to look at`,
196
+ text: `We built the website for ${businessName} with you today. Open it on your phone and look ` + `around: every page, picture and word can still be changed.\n\n${previewUrl}` + (siteAddress ? `\n\nIt will live at ${siteAddress}.` : '')
197
+ });
198
+ const result = await sendEmail(_extends({
199
+ to: intake.email,
200
+ subject: content.subject,
201
+ text: content.text
202
+ }, content.html ? {
203
+ html: content.html
204
+ } : {}, brand.fromName ? {
205
+ fromName: brand.fromName
206
+ } : {}, {
207
+ context: 'client-build-preview'
208
+ }));
209
+ emailed = result.sent;
210
+ if (result.sent) await meterOrgEmail(orgId);
211
+ } catch (error) {
212
+ console.error('[client-build] the preview email failed', error);
213
+ }
214
+ }
215
+ let text = 'none';
216
+ const phone = clientBuildPhone(intake);
217
+ if (phone) {
218
+ const sms = pluginSmsMessaging();
219
+ if (!(sms == null ? void 0 : sms.isConfigured())) text = 'unavailable';
220
+ else {
221
+ const outcome = await sms.send({
222
+ to: phone,
223
+ body: clientBuildPreviewText({
224
+ businessName,
225
+ previewUrl,
226
+ siteAddress,
227
+ productName
228
+ }),
229
+ hostId: record.hostId,
230
+ // Owed to the owner's own request, at the booth or the door, and
231
+ // waited on right now: never held for quiet hours.
232
+ purpose: 'transactional',
233
+ context: 'client-build-preview'
234
+ });
235
+ text = outcome.status;
236
+ }
237
+ }
238
+ const sentAt = (_options_now = options.now) != null ? _options_now : Date.now();
239
+ if (emailed || text === 'sent') await recordRef(orgId).set({
240
+ previewSentAt: sentAt
241
+ }, {
242
+ merge: true
243
+ });
244
+ await addAdminAudit(firestore(), {
245
+ actorUid,
246
+ action: 'client-build.preview-sent',
247
+ target: `orgs/${orgId}`,
248
+ // Which channels went, never the owner's address or number.
249
+ after: {
250
+ hostId: record.hostId,
251
+ emailed,
252
+ text
253
+ },
254
+ at: firebaseAdmin.firestore.FieldValue.serverTimestamp()
255
+ });
256
+ return {
257
+ emailed,
258
+ text,
259
+ previewUrl,
260
+ siteAddress
261
+ };
262
+ }
263
+
264
+ //# sourceMappingURL=client-build.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../../../../../../../../libs/tenant/data/admin/src/lib/server/client-build.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 {\n CLIENT_BUILD_COLLECTION,\n CLIENT_BUILD_DOC_ID,\n clientBuildIntent,\n clientBuildPhone,\n clientBuildPreviewText,\n clientBuildSiteAddress,\n EMPTY_CLIENT_BUILD_INTAKE,\n parseClientBuildDomain,\n parseClientBuildIntake,\n readClientBuildIntent,\n type ClientBuildDomain,\n type ClientBuildIntent,\n type ClientBuildRecord,\n} from '@aglyn/aglyn/app-utils/client-build'\nimport { hostPublicOrigin } from '@aglyn/aglyn/app-utils/host-naming'\nimport { readOrgPlanComp } from '@aglyn/aglyn/app-utils/plan-entitlements'\nimport { PLATFORM_BRAND_NAME } from '@aglyn/aglyn/app-utils/platform-brand'\nimport {\n pluginSmsMessaging,\n type PluginSmsSendOutcome,\n} from '@aglyn/aglyn/plugin-manager/plugin-sms-messaging'\nimport type { AglynOrgBilling } from '@aglyn/aglyn/server'\nimport { isEmailConfigured, sendEmail } from '@aglyn/shared-util-email'\nimport { addAdminAudit } from './admin-audit-write'\nimport { meterOrgEmail } from './email-metering'\nimport firebaseAdmin from './firebase-admin'\nimport { renderSystemEmailContent, systemEmailBrand } from './render-system-email'\n\n/**\n * THE ONE-SCREEN BUILD FOR A CLIENT, ON THE SERVER (AGL-3958).\n *\n * One record per workspace, at `orgs/{orgId}/clientBuild/current`, which the\n * rules open to no client: the owner's phone and email are staff's to hold\n * until the owner joins, and the org document is read by every member. Only\n * `/api/admin/client-build` (staff) calls this module.\n */\n\nconst firestore = () => firebaseAdmin.app().firestore()\n\n/** A refusal the route answers with its status. */\nexport class ClientBuildError extends Error {\n constructor(\n message: string,\n readonly status: number,\n ) {\n super(message)\n this.name = 'ClientBuildError'\n }\n}\n\nfunction recordRef(orgId: string) {\n return firestore().collection('orgs').doc(orgId).collection(CLIENT_BUILD_COLLECTION).doc(CLIENT_BUILD_DOC_ID)\n}\n\n/** A stored record, read back defensively; `null` when the workspace has none. */\nexport function readClientBuildRecord(raw: unknown): ClientBuildRecord | null {\n if (!raw || typeof raw !== 'object') return null\n const source = raw as Record<string, unknown>\n const intake = parseClientBuildIntake(source['intake'])\n const domain = source['domain'] ? parseClientBuildDomain(source['domain']) : null\n const intent = readClientBuildIntent(source['intent'])\n const text = (value: unknown) => (typeof value === 'string' && value ? value : null)\n const time = (value: unknown) => (typeof value === 'number' && Number.isFinite(value) ? value : null)\n return {\n // A stored intake that no longer validates is still the one staff typed.\n intake: typeof intake === 'string' ? { ...EMPTY_CLIENT_BUILD_INTAKE, ...(source['intake'] as object) } : intake,\n domain: typeof domain === 'string' ? null : domain,\n intent: intent ?? clientBuildIntent({ plan: null, domain: typeof domain === 'string' ? null : domain }),\n hostId: text(source['hostId']),\n host: text(source['host']),\n jobId: text(source['jobId']),\n starter: source['starter'] === true,\n previewSentAt: time(source['previewSentAt']),\n updatedAt: time(source['updatedAt']) ?? 0,\n updatedBy: text(source['updatedBy']) ?? '',\n }\n}\n\n/** The workspace's build, or `null` before one was started. */\nexport async function loadClientBuild(orgId: string): Promise<ClientBuildRecord | null> {\n const snapshot = await recordRef(orgId).get()\n return snapshot.exists ? readClientBuildRecord(snapshot.data()) : null\n}\n\n/**\n * The intent the hand-off proposes (AGL-3955, AGL-3956): what the build left\n * for the owner's checkout, or `null` when the workspace was not built here.\n */\nexport async function loadClientBuildIntent(orgId: string): Promise<ClientBuildIntent | null> {\n return (await loadClientBuild(orgId))?.intent ?? null\n}\n\n/** What a save may change; each part left out keeps what is stored. */\nexport interface ClientBuildPatch {\n intake?: unknown\n domain?: unknown\n hostId?: unknown\n host?: unknown\n jobId?: unknown\n /** `true` once the starter site was given instead of a guided start. */\n starter?: unknown\n}\n\nconst ID_PATTERN = /^[A-Za-z0-9_-]{1,128}$/\n\n/**\n * Writes the build, merged over what is stored. The intake and the domain\n * are validated as the screen validated them; the intent is derived, never\n * taken from the body: the plan the workspace was comped on, Site Care, and\n * the domain the Domain step recorded. A site is accepted only when it\n * belongs to this workspace.\n */\nexport async function saveClientBuild(options: {\n orgId: string\n actorUid: string\n patch: ClientBuildPatch\n now?: number\n}): Promise<ClientBuildRecord> {\n const { orgId, actorUid, patch } = options\n const org = await firestore().collection('orgs').doc(orgId).get()\n if (!org.exists) throw new ClientBuildError('Unknown workspace', 404)\n const stored = await loadClientBuild(orgId)\n\n let intake = stored?.intake ?? null\n if (patch.intake !== undefined) {\n const parsed = parseClientBuildIntake(patch.intake)\n if (typeof parsed === 'string') throw new ClientBuildError(parsed, 400)\n intake = parsed\n }\n if (!intake) throw new ClientBuildError('Missing the business details', 400)\n\n let domain: ClientBuildDomain | null = stored?.domain ?? null\n if (patch.domain !== undefined) {\n if (patch.domain === null) domain = null\n else {\n const parsed = parseClientBuildDomain(patch.domain)\n if (typeof parsed === 'string') throw new ClientBuildError(parsed, 400)\n domain = parsed\n }\n }\n\n let hostId = stored?.hostId ?? null\n let host = stored?.host ?? null\n if (patch.hostId !== undefined) {\n const id = String(patch.hostId ?? '')\n if (!ID_PATTERN.test(id)) throw new ClientBuildError('Unknown site', 400)\n const site = await firestore().collection('hosts').doc(id).get()\n if (!site.exists || site.get('orgId') !== orgId) {\n throw new ClientBuildError('That site is not in this workspace', 400)\n }\n hostId = id\n host = typeof site.get('subdomain') === 'string' ? site.get('subdomain') : (patch.host ? String(patch.host) : null)\n }\n\n let jobId = stored?.jobId ?? null\n if (patch.jobId !== undefined) {\n const id = String(patch.jobId ?? '')\n if (!ID_PATTERN.test(id)) throw new ClientBuildError('Unknown job', 400)\n jobId = id\n }\n\n let starter = stored?.starter ?? false\n if (patch.starter !== undefined) {\n if (typeof patch.starter !== 'boolean') throw new ClientBuildError('Unknown starter choice', 400)\n starter = patch.starter\n }\n\n const record: ClientBuildRecord = {\n intake,\n domain,\n // Derived on every write, never taken from the body: the plan the\n // workspace was comped on, Site Care, monthly, and the domain above.\n intent: clientBuildIntent({\n plan: readOrgPlanComp(org.data() as Partial<AglynOrgBilling>)?.plan ?? null,\n domain,\n }),\n hostId,\n host,\n jobId,\n starter,\n previewSentAt: stored?.previewSentAt ?? null,\n updatedAt: options.now ?? Date.now(),\n updatedBy: actorUid,\n }\n await recordRef(orgId).set(record)\n return record\n}\n\n/** What sending the preview came to, per channel. */\nexport interface ClientBuildPreviewOutcome {\n emailed: boolean\n /** The text's outcome; `none` when the intake has no phone to text. */\n text: PluginSmsSendOutcome['status'] | 'none' | 'unavailable'\n previewUrl: string\n siteAddress: string | null\n}\n\n/**\n * Sends the owner the preview: a text and an email with the link to the site\n * as it is now and the address it will live at. Only once the site has a\n * published page, since the link would otherwise open an empty site. Each\n * channel is attempted on its own and reported; the send is an Audit Log row.\n */\nexport async function sendClientBuildPreview(options: {\n orgId: string\n actorUid: string\n now?: number\n}): Promise<ClientBuildPreviewOutcome> {\n const { orgId, actorUid } = options\n const record = await loadClientBuild(orgId)\n if (!record?.hostId) throw new ClientBuildError('Build the site first', 409)\n const [orgSnapshot, siteSnapshot] = await Promise.all([\n firestore().collection('orgs').doc(orgId).get(),\n firestore().collection('hosts').doc(record.hostId).get(),\n ])\n if (!siteSnapshot.exists || siteSnapshot.get('orgId') !== orgId) {\n throw new ClientBuildError('That site is not in this workspace', 409)\n }\n const site = siteSnapshot.data() as { screens?: Record<string, unknown>; subdomain?: string; cname?: string }\n if (!Object.keys(site.screens ?? {}).length) {\n throw new ClientBuildError('The site has no published page yet', 409)\n }\n const previewUrl = hostPublicOrigin({ subdomain: site.subdomain ?? null })\n if (!previewUrl) throw new ClientBuildError('The site has no address yet', 409)\n const siteAddress = clientBuildSiteAddress(record.domain, previewUrl)\n const { intake } = record\n const businessName = intake.businessName || 'your business'\n\n const brand = systemEmailBrand(orgSnapshot.data() as Record<string, unknown>)\n const productName = brand.merge['brand.productName'] || PLATFORM_BRAND_NAME\n\n let emailed = false\n if (intake.email && isEmailConfigured()) {\n try {\n const content = await renderSystemEmailContent(\n 'client-build-preview',\n {\n 'business.name': businessName,\n 'preview.url': previewUrl,\n 'site.address': siteAddress ?? previewUrl,\n },\n brand,\n {\n subject: `Your new website for ${businessName} is ready to look at`,\n text:\n `We built the website for ${businessName} with you today. Open it on your phone and look ` +\n `around: every page, picture and word can still be changed.\\n\\n${previewUrl}` +\n (siteAddress ? `\\n\\nIt will live at ${siteAddress}.` : ''),\n },\n )\n const result = await sendEmail({\n to: intake.email,\n subject: content.subject,\n text: content.text,\n ...(content.html ? { html: content.html } : {}),\n ...(brand.fromName ? { fromName: brand.fromName } : {}),\n context: 'client-build-preview',\n })\n emailed = result.sent\n if (result.sent) await meterOrgEmail(orgId)\n } catch (error) {\n console.error('[client-build] the preview email failed', error)\n }\n }\n\n let text: ClientBuildPreviewOutcome['text'] = 'none'\n const phone = clientBuildPhone(intake)\n if (phone) {\n const sms = pluginSmsMessaging()\n if (!sms?.isConfigured()) text = 'unavailable'\n else {\n const outcome = await sms.send({\n to: phone,\n body: clientBuildPreviewText({ businessName, previewUrl, siteAddress, productName }),\n hostId: record.hostId,\n // Owed to the owner's own request, at the booth or the door, and\n // waited on right now: never held for quiet hours.\n purpose: 'transactional',\n context: 'client-build-preview',\n })\n text = outcome.status\n }\n }\n\n const sentAt = options.now ?? Date.now()\n if (emailed || text === 'sent') await recordRef(orgId).set({ previewSentAt: sentAt }, { merge: true })\n await addAdminAudit(firestore(), {\n actorUid,\n action: 'client-build.preview-sent',\n target: `orgs/${orgId}`,\n // Which channels went, never the owner's address or number.\n after: { hostId: record.hostId, emailed, text },\n at: firebaseAdmin.firestore.FieldValue.serverTimestamp(),\n })\n return { emailed, text, previewUrl, siteAddress }\n}\n"],"names":["CLIENT_BUILD_COLLECTION","CLIENT_BUILD_DOC_ID","clientBuildIntent","clientBuildPhone","clientBuildPreviewText","clientBuildSiteAddress","EMPTY_CLIENT_BUILD_INTAKE","parseClientBuildDomain","parseClientBuildIntake","readClientBuildIntent","hostPublicOrigin","readOrgPlanComp","PLATFORM_BRAND_NAME","pluginSmsMessaging","isEmailConfigured","sendEmail","addAdminAudit","meterOrgEmail","firebaseAdmin","renderSystemEmailContent","systemEmailBrand","firestore","app","ClientBuildError","Error","message","status","name","recordRef","orgId","collection","doc","readClientBuildRecord","raw","time","text","source","intake","domain","intent","value","Number","isFinite","plan","hostId","host","jobId","starter","previewSentAt","updatedAt","updatedBy","loadClientBuild","snapshot","get","exists","data","loadClientBuildIntent","ID_PATTERN","saveClientBuild","options","actorUid","patch","org","stored","undefined","parsed","id","String","test","site","record","now","Date","set","sendClientBuildPreview","orgSnapshot","siteSnapshot","Promise","all","Object","keys","screens","length","previewUrl","subdomain","siteAddress","businessName","brand","productName","merge","emailed","email","content","subject","result","to","html","fromName","context","sent","error","console","phone","sms","isConfigured","outcome","send","body","purpose","sentAt","action","target","after","at","FieldValue","serverTimestamp"],"mappings":";AAAA;;;;;;;;;;;;;;;CAeC,GAED,SACEA,uBAAuB,EACvBC,mBAAmB,EACnBC,iBAAiB,EACjBC,gBAAgB,EAChBC,sBAAsB,EACtBC,sBAAsB,EACtBC,yBAAyB,EACzBC,sBAAsB,EACtBC,sBAAsB,EACtBC,qBAAqB,QAIhB,sCAAqC;AAC5C,SAASC,gBAAgB,QAAQ,qCAAoC;AACrE,SAASC,eAAe,QAAQ,2CAA0C;AAC1E,SAASC,mBAAmB,QAAQ,wCAAuC;AAC3E,SACEC,kBAAkB,QAEb,mDAAkD;AAEzD,SAASC,iBAAiB,EAAEC,SAAS,QAAQ,2BAA0B;AACvE,SAASC,aAAa,QAAQ,yBAAqB;AACnD,SAASC,aAAa,QAAQ,sBAAkB;AAChD,OAAOC,mBAAmB,sBAAkB;AAC5C,SAASC,wBAAwB,EAAEC,gBAAgB,QAAQ,2BAAuB;AAElF;;;;;;;CAOC,GAED,MAAMC,YAAY,IAAMH,cAAcI,GAAG,GAAGD,SAAS;AAErD,iDAAiD,GACjD,OAAO,MAAME,yBAAyBC;IACpC,YACEC,OAAe,EACf,AAASC,MAAc,CACvB;QACA,KAAK,CAACD,eAFGC,SAAAA;QAGT,IAAI,CAACC,IAAI,GAAG;IACd;AACF;AAEA,SAASC,UAAUC,KAAa;IAC9B,OAAOR,YAAYS,UAAU,CAAC,QAAQC,GAAG,CAACF,OAAOC,UAAU,CAAC9B,yBAAyB+B,GAAG,CAAC9B;AAC3F;AAEA,gFAAgF,GAChF,OAAO,SAAS+B,sBAAsBC,GAAY;QAkBnCC,OACAC;IAlBb,IAAI,CAACF,OAAO,OAAOA,QAAQ,UAAU,OAAO;IAC5C,MAAMG,SAASH;IACf,MAAMI,SAAS7B,uBAAuB4B,MAAM,CAAC,SAAS;IACtD,MAAME,SAASF,MAAM,CAAC,SAAS,GAAG7B,uBAAuB6B,MAAM,CAAC,SAAS,IAAI;IAC7E,MAAMG,SAAS9B,sBAAsB2B,MAAM,CAAC,SAAS;IACrD,MAAMD,OAAO,CAACK,QAAoB,OAAOA,UAAU,YAAYA,QAAQA,QAAQ;IAC/E,MAAMN,OAAO,CAACM,QAAoB,OAAOA,UAAU,YAAYC,OAAOC,QAAQ,CAACF,SAASA,QAAQ;IAChG,OAAO;QACL,yEAAyE;QACzEH,QAAQ,OAAOA,WAAW,WAAW,aAAK/B,2BAA+B8B,MAAM,CAAC,SAAS,IAAgBC;QACzGC,QAAQ,OAAOA,WAAW,WAAW,OAAOA;QAC5CC,MAAM,EAAEA,iBAAAA,SAAUrC,kBAAkB;YAAEyC,MAAM;YAAML,QAAQ,OAAOA,WAAW,WAAW,OAAOA;QAAO;QACrGM,QAAQT,KAAKC,MAAM,CAAC,SAAS;QAC7BS,MAAMV,KAAKC,MAAM,CAAC,OAAO;QACzBU,OAAOX,KAAKC,MAAM,CAAC,QAAQ;QAC3BW,SAASX,MAAM,CAAC,UAAU,KAAK;QAC/BY,eAAed,KAAKE,MAAM,CAAC,gBAAgB;QAC3Ca,SAAS,GAAEf,QAAAA,KAAKE,MAAM,CAAC,YAAY,aAAxBF,QAA6B;QACxCgB,SAAS,GAAEf,QAAAA,KAAKC,MAAM,CAAC,YAAY,aAAxBD,QAA6B;IAC1C;AACF;AAEA,6DAA6D,GAC7D,OAAO,eAAegB,gBAAgBtB,KAAa;IACjD,MAAMuB,WAAW,MAAMxB,UAAUC,OAAOwB,GAAG;IAC3C,OAAOD,SAASE,MAAM,GAAGtB,sBAAsBoB,SAASG,IAAI,MAAM;AACpE;AAEA;;;CAGC,GACD,OAAO,eAAeC,sBAAsB3B,KAAa;;QAC/C;IAAR,gBAAQ,QAAA,MAAMsB,gBAAgBtB,2BAAvB,AAAC,MAA+BU,MAAM,mBAAI;AACnD;AAaA,MAAMkB,aAAa;AAEnB;;;;;;CAMC,GACD,OAAO,eAAeC,gBAAgBC,OAKrC;+DAgEcA;QARHhD;IAvDV,MAAM,EAAEkB,KAAK,EAAE+B,QAAQ,EAAEC,KAAK,EAAE,GAAGF;IACnC,MAAMG,MAAM,MAAMzC,YAAYS,UAAU,CAAC,QAAQC,GAAG,CAACF,OAAOwB,GAAG;IAC/D,IAAI,CAACS,IAAIR,MAAM,EAAE,MAAM,IAAI/B,iBAAiB,qBAAqB;IACjE,MAAMwC,SAAS,MAAMZ,gBAAgBtB;IAErC,IAAIQ,iBAAS0B,0BAAAA,OAAQ1B,MAAM,mBAAI;IAC/B,IAAIwB,MAAMxB,MAAM,KAAK2B,WAAW;QAC9B,MAAMC,SAASzD,uBAAuBqD,MAAMxB,MAAM;QAClD,IAAI,OAAO4B,WAAW,UAAU,MAAM,IAAI1C,iBAAiB0C,QAAQ;QACnE5B,SAAS4B;IACX;IACA,IAAI,CAAC5B,QAAQ,MAAM,IAAId,iBAAiB,gCAAgC;IAExE,IAAIe,kBAAmCyB,0BAAAA,OAAQzB,MAAM,oBAAI;IACzD,IAAIuB,MAAMvB,MAAM,KAAK0B,WAAW;QAC9B,IAAIH,MAAMvB,MAAM,KAAK,MAAMA,SAAS;aAC/B;YACH,MAAM2B,SAAS1D,uBAAuBsD,MAAMvB,MAAM;YAClD,IAAI,OAAO2B,WAAW,UAAU,MAAM,IAAI1C,iBAAiB0C,QAAQ;YACnE3B,SAAS2B;QACX;IACF;IAEA,IAAIrB,kBAASmB,0BAAAA,OAAQnB,MAAM,oBAAI;IAC/B,IAAIC,gBAAOkB,0BAAAA,OAAQlB,IAAI,oBAAI;IAC3B,IAAIgB,MAAMjB,MAAM,KAAKoB,WAAW;YACZH;QAAlB,MAAMK,KAAKC,QAAON,gBAAAA,MAAMjB,MAAM,YAAZiB,gBAAgB;QAClC,IAAI,CAACJ,WAAWW,IAAI,CAACF,KAAK,MAAM,IAAI3C,iBAAiB,gBAAgB;QACrE,MAAM8C,OAAO,MAAMhD,YAAYS,UAAU,CAAC,SAASC,GAAG,CAACmC,IAAIb,GAAG;QAC9D,IAAI,CAACgB,KAAKf,MAAM,IAAIe,KAAKhB,GAAG,CAAC,aAAaxB,OAAO;YAC/C,MAAM,IAAIN,iBAAiB,sCAAsC;QACnE;QACAqB,SAASsB;QACTrB,OAAO,OAAOwB,KAAKhB,GAAG,CAAC,iBAAiB,WAAWgB,KAAKhB,GAAG,CAAC,eAAgBQ,MAAMhB,IAAI,GAAGsB,OAAON,MAAMhB,IAAI,IAAI;IAChH;IAEA,IAAIC,iBAAQiB,0BAAAA,OAAQjB,KAAK,oBAAI;IAC7B,IAAIe,MAAMf,KAAK,KAAKkB,WAAW;YACXH;QAAlB,MAAMK,KAAKC,QAAON,eAAAA,MAAMf,KAAK,YAAXe,eAAe;QACjC,IAAI,CAACJ,WAAWW,IAAI,CAACF,KAAK,MAAM,IAAI3C,iBAAiB,eAAe;QACpEuB,QAAQoB;IACV;IAEA,IAAInB,mBAAUgB,0BAAAA,OAAQhB,OAAO,oBAAI;IACjC,IAAIc,MAAMd,OAAO,KAAKiB,WAAW;QAC/B,IAAI,OAAOH,MAAMd,OAAO,KAAK,WAAW,MAAM,IAAIxB,iBAAiB,0BAA0B;QAC7FwB,UAAUc,MAAMd,OAAO;IACzB;IAEA,MAAMuB,SAA4B;QAChCjC;QACAC;QACA,kEAAkE;QAClE,qEAAqE;QACrEC,QAAQrC,kBAAkB;YACxByC,IAAI,YAAEhC,mBAAAA,gBAAgBmD,IAAIP,IAAI,wBAAxB5C,iBAAyDgC,IAAI,oBAAI;YACvEL;QACF;QACAM;QACAC;QACAC;QACAC;QACAC,aAAa,WAAEe,0BAAAA,OAAQf,aAAa,oBAAI;QACxCC,SAAS,GAAEU,eAAAA,QAAQY,GAAG,YAAXZ,eAAea,KAAKD,GAAG;QAClCrB,WAAWU;IACb;IACA,MAAMhC,UAAUC,OAAO4C,GAAG,CAACH;IAC3B,OAAOA;AACT;AAWA;;;;;CAKC,GACD,OAAO,eAAeI,uBAAuBf,OAI5C;QAYkBU,eAGgCA,iBA8DlCV;IA5Ef,MAAM,EAAE9B,KAAK,EAAE+B,QAAQ,EAAE,GAAGD;IAC5B,MAAMW,SAAS,MAAMnB,gBAAgBtB;IACrC,IAAI,EAACyC,0BAAAA,OAAQ1B,MAAM,GAAE,MAAM,IAAIrB,iBAAiB,wBAAwB;IACxE,MAAM,CAACoD,aAAaC,aAAa,GAAG,MAAMC,QAAQC,GAAG,CAAC;QACpDzD,YAAYS,UAAU,CAAC,QAAQC,GAAG,CAACF,OAAOwB,GAAG;QAC7ChC,YAAYS,UAAU,CAAC,SAASC,GAAG,CAACuC,OAAO1B,MAAM,EAAES,GAAG;KACvD;IACD,IAAI,CAACuB,aAAatB,MAAM,IAAIsB,aAAavB,GAAG,CAAC,aAAaxB,OAAO;QAC/D,MAAM,IAAIN,iBAAiB,sCAAsC;IACnE;IACA,MAAM8C,OAAOO,aAAarB,IAAI;IAC9B,IAAI,CAACwB,OAAOC,IAAI,EAACX,gBAAAA,KAAKY,OAAO,YAAZZ,gBAAgB,CAAC,GAAGa,MAAM,EAAE;QAC3C,MAAM,IAAI3D,iBAAiB,sCAAsC;IACnE;IACA,MAAM4D,aAAazE,iBAAiB;QAAE0E,SAAS,GAAEf,kBAAAA,KAAKe,SAAS,YAAdf,kBAAkB;IAAK;IACxE,IAAI,CAACc,YAAY,MAAM,IAAI5D,iBAAiB,+BAA+B;IAC3E,MAAM8D,cAAchF,uBAAuBiE,OAAOhC,MAAM,EAAE6C;IAC1D,MAAM,EAAE9C,MAAM,EAAE,GAAGiC;IACnB,MAAMgB,eAAejD,OAAOiD,YAAY,IAAI;IAE5C,MAAMC,QAAQnE,iBAAiBuD,YAAYpB,IAAI;IAC/C,MAAMiC,cAAcD,MAAME,KAAK,CAAC,oBAAoB,IAAI7E;IAExD,IAAI8E,UAAU;IACd,IAAIrD,OAAOsD,KAAK,IAAI7E,qBAAqB;QACvC,IAAI;YACF,MAAM8E,UAAU,MAAMzE,yBACpB,wBACA;gBACE,iBAAiBmE;gBACjB,eAAeH;gBACf,cAAc,EAAEE,sBAAAA,cAAeF;YACjC,GACAI,OACA;gBACEM,SAAS,CAAC,qBAAqB,EAAEP,aAAa,oBAAoB,CAAC;gBACnEnD,MACE,CAAC,yBAAyB,EAAEmD,aAAa,gDAAgD,CAAC,GAC1F,CAAC,8DAA8D,EAAEH,YAAY,GAC5EE,CAAAA,cAAc,CAAC,oBAAoB,EAAEA,YAAY,CAAC,CAAC,GAAG,EAAC;YAC5D;YAEF,MAAMS,SAAS,MAAM/E,UAAU;gBAC7BgF,IAAI1D,OAAOsD,KAAK;gBAChBE,SAASD,QAAQC,OAAO;gBACxB1D,MAAMyD,QAAQzD,IAAI;eACdyD,QAAQI,IAAI,GAAG;gBAAEA,MAAMJ,QAAQI,IAAI;YAAC,IAAI,CAAC,GACzCT,MAAMU,QAAQ,GAAG;gBAAEA,UAAUV,MAAMU,QAAQ;YAAC,IAAI,CAAC;gBACrDC,SAAS;;YAEXR,UAAUI,OAAOK,IAAI;YACrB,IAAIL,OAAOK,IAAI,EAAE,MAAMlF,cAAcY;QACvC,EAAE,OAAOuE,OAAO;YACdC,QAAQD,KAAK,CAAC,2CAA2CA;QAC3D;IACF;IAEA,IAAIjE,OAA0C;IAC9C,MAAMmE,QAAQnG,iBAAiBkC;IAC/B,IAAIiE,OAAO;QACT,MAAMC,MAAM1F;QACZ,IAAI,EAAC0F,uBAAAA,IAAKC,YAAY,KAAIrE,OAAO;aAC5B;YACH,MAAMsE,UAAU,MAAMF,IAAIG,IAAI,CAAC;gBAC7BX,IAAIO;gBACJK,MAAMvG,uBAAuB;oBAAEkF;oBAAcH;oBAAYE;oBAAaG;gBAAY;gBAClF5C,QAAQ0B,OAAO1B,MAAM;gBACrB,iEAAiE;gBACjE,mDAAmD;gBACnDgE,SAAS;gBACTV,SAAS;YACX;YACA/D,OAAOsE,QAAQ/E,MAAM;QACvB;IACF;IAEA,MAAMmF,UAASlD,eAAAA,QAAQY,GAAG,YAAXZ,eAAea,KAAKD,GAAG;IACtC,IAAImB,WAAWvD,SAAS,QAAQ,MAAMP,UAAUC,OAAO4C,GAAG,CAAC;QAAEzB,eAAe6D;IAAO,GAAG;QAAEpB,OAAO;IAAK;IACpG,MAAMzE,cAAcK,aAAa;QAC/BuC;QACAkD,QAAQ;QACRC,QAAQ,CAAC,KAAK,EAAElF,OAAO;QACvB,4DAA4D;QAC5DmF,OAAO;YAAEpE,QAAQ0B,OAAO1B,MAAM;YAAE8C;YAASvD;QAAK;QAC9C8E,IAAI/F,cAAcG,SAAS,CAAC6F,UAAU,CAACC,eAAe;IACxD;IACA,OAAO;QAAEzB;QAASvD;QAAMgD;QAAYE;IAAY;AAClD"}
@@ -0,0 +1,205 @@
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 DnsLookupResult } from './dns-probe';
18
+ /** The subcollection under `orgs/{orgId}`; the document id is the domain. */
19
+ export declare const DOMAIN_OWNERSHIP_CLAIMS_COLLECTION = "domainOwnershipClaims";
20
+ /** The `name` of the home page meta tag that carries the token. */
21
+ export declare const DOMAIN_OWNERSHIP_META_NAME = "aglyn-site-verification";
22
+ /** The system email that carries the one-time code. */
23
+ export declare const DOMAIN_OWNERSHIP_CODE_EMAIL_KEY = "domain-ownership-code";
24
+ /** How long an emailed code works. */
25
+ export declare const DOMAIN_OWNERSHIP_CODE_TTL_MS: number;
26
+ /** Wrong codes allowed before the code is burned and a new one must be sent. */
27
+ export declare const DOMAIN_OWNERSHIP_CODE_MAX_ATTEMPTS = 5;
28
+ /** The least time between two codes for one claim. */
29
+ export declare const DOMAIN_OWNERSHIP_CODE_RESEND_MS: number;
30
+ /** Codes one workspace may send in an hour, across every claim. */
31
+ export declare const DOMAIN_OWNERSHIP_CODES_PER_ORG_PER_HOUR = 10;
32
+ /** Codes one address may receive in an hour, from every workspace. */
33
+ export declare const DOMAIN_OWNERSHIP_CODES_PER_ADDRESS_PER_HOUR = 5;
34
+ /**
35
+ * How long a proof stands before an import asks for it again. A domain can
36
+ * lapse and be bought by someone else; a month is short enough that the new
37
+ * owner's content is not imported on the old owner's proof.
38
+ */
39
+ export declare const DOMAIN_OWNERSHIP_PROOF_MAX_AGE_MS: number;
40
+ export type DomainOwnershipMethod = 'dns' | 'meta' | 'email';
41
+ /** What one check found. `unreachable` is evidence in neither direction. */
42
+ export type DomainOwnershipCheckStatus = 'proven' | 'not-yet' | 'unreachable';
43
+ /** The stored document. Times are epoch milliseconds. */
44
+ export interface DomainOwnershipClaimDoc {
45
+ domain: string;
46
+ token: string;
47
+ status: 'pending' | 'proven';
48
+ createdAt: number;
49
+ createdBy: string;
50
+ provenMethod?: DomainOwnershipMethod;
51
+ provenAt?: number;
52
+ /** The record host, the page, or the address the proof came from. */
53
+ provenDetail?: string;
54
+ lastCheckedAt?: number;
55
+ lastChecks?: Partial<Record<DomainOwnershipMethod, DomainOwnershipCheckStatus>>;
56
+ emailCode?: {
57
+ address: string;
58
+ /** HMAC-SHA256 of the code, keyed by the signing secret. Never the code. */
59
+ hash: string;
60
+ sentAt: number;
61
+ expiresAt: number;
62
+ attempts: number;
63
+ } | null;
64
+ }
65
+ /** What the console is shown: the instructions, never the code's hash. */
66
+ export interface DomainOwnershipClaimView {
67
+ domain: string;
68
+ status: 'pending' | 'proven';
69
+ /** False once a proof is older than {@link DOMAIN_OWNERSHIP_PROOF_MAX_AGE_MS}. */
70
+ current: boolean;
71
+ provenMethod: DomainOwnershipMethod | null;
72
+ provenAt: number | null;
73
+ provenDetail: string | null;
74
+ lastChecks: Partial<Record<DomainOwnershipMethod, DomainOwnershipCheckStatus>>;
75
+ dns: {
76
+ host: string;
77
+ type: 'TXT';
78
+ value: string;
79
+ };
80
+ meta: {
81
+ name: string;
82
+ content: string;
83
+ tag: string;
84
+ };
85
+ email: {
86
+ /** Addresses must end in `@<domain>`. */
87
+ domain: string;
88
+ pendingAddress: string | null;
89
+ expiresAt: number | null;
90
+ attemptsLeft: number | null;
91
+ };
92
+ }
93
+ export interface DomainOwnershipCheckResult {
94
+ method: DomainOwnershipMethod;
95
+ status: DomainOwnershipCheckStatus;
96
+ /** A sentence for the person: what was looked at, and what to do next. */
97
+ message: string;
98
+ claim: DomainOwnershipClaimView;
99
+ }
100
+ /** `{ value, error }`, both keys always present, as `validateSsoDomain` does. */
101
+ export interface OwnershipDomainCheck {
102
+ domain: string | null;
103
+ error: string | null;
104
+ }
105
+ /** A home page's `aglyn-site-verification` values, read by the caller. */
106
+ export type ReadVerificationMeta = (domain: string) => Promise<{
107
+ answered: boolean;
108
+ values: string[];
109
+ url?: string;
110
+ }>;
111
+ /** Sends the code; the default is {@link deliverDomainOwnershipCode}. */
112
+ export type DeliverDomainOwnershipCode = (input: {
113
+ orgId: string;
114
+ org: Record<string, unknown> | null;
115
+ domain: string;
116
+ address: string;
117
+ code: string;
118
+ expiresInMinutes: number;
119
+ }) => Promise<{
120
+ sent: boolean;
121
+ status?: number;
122
+ error?: string;
123
+ }>;
124
+ export interface DomainOwnershipDeps {
125
+ firestore?: FirebaseFirestore.Firestore;
126
+ lookupTxt?: (host: string) => Promise<DnsLookupResult<string>>;
127
+ readVerificationMeta?: ReadVerificationMeta;
128
+ deliverCode?: DeliverDomainOwnershipCode;
129
+ now?: () => number;
130
+ /** The HMAC key for codes; the default is `TOKEN_SIGNING_SECRET`. */
131
+ secret?: () => string;
132
+ mintToken?: () => string;
133
+ mintCode?: () => string;
134
+ }
135
+ /**
136
+ * The domain a claim is about: lowercased, any scheme, path, port or address
137
+ * prefix a person pasted removed, and a leading `www.` folded into the bare
138
+ * name, because the site's two names are one site to its owner and the
139
+ * crawler treats them as one origin.
140
+ */
141
+ export declare function normalizeOwnershipDomain(input: string): OwnershipDomainCheck;
142
+ /** The TXT record host for a domain. */
143
+ export declare function domainOwnershipRecordHost(domain: string): string;
144
+ /** The meta tag a person pastes into their home page's `<head>`. */
145
+ export declare function domainOwnershipMetaTag(token: string): string;
146
+ /** Exact, whole-value match, for the reason `recordsProveOwnership` gives. */
147
+ export declare function metaValuesProveOwnership(values: readonly string[], token: string): boolean;
148
+ /**
149
+ * The address a code may go to: a plausible mailbox whose domain IS the
150
+ * claim's domain (the `www.` twin included), and nothing else. A parent or a
151
+ * sibling domain proves nothing about this one.
152
+ */
153
+ export declare function ownershipEmailAddress(input: string, domain: string): string | null;
154
+ /** HMAC of a code, bound to the claim and the address it was sent to. */
155
+ export declare function hashOwnershipCode(secret: string, input: {
156
+ orgId: string;
157
+ domain: string;
158
+ address: string;
159
+ code: string;
160
+ }): string;
161
+ /** Whether a stored proof is still one an import may rely on. */
162
+ export declare function isOwnershipProofCurrent(claim: Pick<DomainOwnershipClaimDoc, 'status' | 'provenAt'> | null | undefined, now: number): boolean;
163
+ export declare function domainOwnershipClaimView(claim: DomainOwnershipClaimDoc, now: number): DomainOwnershipClaimView;
164
+ /**
165
+ * Start (or re-read) a claim. Idempotent: an existing claim keeps its token,
166
+ * because a new one would break a record or tag the person already published.
167
+ */
168
+ export declare function issueDomainOwnershipClaim(orgId: string, rawDomain: string, uid: string, deps?: DomainOwnershipDeps): Promise<{
169
+ claim: DomainOwnershipClaimView | null;
170
+ error: string | null;
171
+ }>;
172
+ /** Every claim the org holds, newest first. */
173
+ export declare function listDomainOwnershipClaims(orgId: string, deps?: DomainOwnershipDeps): Promise<DomainOwnershipClaimView[]>;
174
+ /**
175
+ * Whether the org holds a CURRENT proof for the domain: the one question an
176
+ * import asks before it pulls a page or an image.
177
+ */
178
+ export declare function isDomainOwnershipProven(orgId: string, rawDomain: string, deps?: DomainOwnershipDeps): Promise<boolean>;
179
+ /** Look for the DNS record or the meta tag now. */
180
+ export declare function checkDomainOwnership(orgId: string, rawDomain: string, method: 'dns' | 'meta', deps?: DomainOwnershipDeps): Promise<{
181
+ result: DomainOwnershipCheckResult | null;
182
+ error: string | null;
183
+ }>;
184
+ /** Email a one-time code to an address at the domain. */
185
+ export declare function sendDomainOwnershipCode(orgId: string, rawDomain: string, rawAddress: string, context: {
186
+ org: Record<string, unknown> | null;
187
+ }, deps?: DomainOwnershipDeps): Promise<{
188
+ claim: DomainOwnershipClaimView | null;
189
+ error: string | null;
190
+ status: number;
191
+ }>;
192
+ /**
193
+ * Check a code the person typed. Counted in a transaction, so parallel
194
+ * guesses cannot get past the attempt limit between a read and a write.
195
+ */
196
+ export declare function confirmDomainOwnershipCode(orgId: string, rawDomain: string, rawCode: string, deps?: DomainOwnershipDeps): Promise<{
197
+ result: DomainOwnershipCheckResult | null;
198
+ error: string | null;
199
+ }>;
200
+ /**
201
+ * Sends the `domain-ownership-code` system email in the workspace's brand,
202
+ * after two ceilings: per workspace, so one cannot mail a domain's whole
203
+ * staff, and per address, so no address is flooded from many workspaces.
204
+ */
205
+ export declare const deliverDomainOwnershipCode: DeliverDomainOwnershipCode;