@aglyn/tenant-data-admin 1.0.0-beta.289 → 1.0.0-beta.290
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/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 +167 -0
- package/src/lib/server/visitor-upload.js +364 -0
- package/src/lib/server/visitor-upload.js.map +1 -0
|
@@ -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,167 @@
|
|
|
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 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.
|
|
129
|
+
*/
|
|
130
|
+
export declare function mintVisitorUploadTicket(deps: VisitorUploadDeps, input: {
|
|
131
|
+
scope: VisitorUploadScope;
|
|
132
|
+
request: unknown;
|
|
133
|
+
caller: VisitorUploadCaller;
|
|
134
|
+
limits?: VisitorUploadLimits;
|
|
135
|
+
maxBytes?: number;
|
|
136
|
+
}): Promise<VisitorUploadTicket | VisitorUploadRefusal>;
|
|
137
|
+
/**
|
|
138
|
+
* Checks and keeps the file a ticket signed for. The ticket must be one this
|
|
139
|
+
* signed, for this `scope`, not long lapsed. Idempotent: a retried finalize
|
|
140
|
+
* of a file already kept answers its record.
|
|
141
|
+
*/
|
|
142
|
+
export declare function finalizeVisitorUpload(deps: VisitorUploadDeps, input: {
|
|
143
|
+
scope: VisitorUploadScope;
|
|
144
|
+
ticket: unknown;
|
|
145
|
+
caller: VisitorUploadCaller;
|
|
146
|
+
}): Promise<{
|
|
147
|
+
ok: true;
|
|
148
|
+
file: VisitorUploadFile;
|
|
149
|
+
} | VisitorUploadRefusal>;
|
|
150
|
+
/** A kept file's record, by its id within `scope`; null when there is none. */
|
|
151
|
+
export declare function readVisitorUpload(deps: Pick<VisitorUploadDeps, 'bucket'>, scope: VisitorUploadScope, id: string): Promise<VisitorUploadFile | null>;
|
|
152
|
+
/** Deletes one kept file. Gone already is fine. */
|
|
153
|
+
export declare function deleteVisitorUpload(deps: Pick<VisitorUploadDeps, 'bucket'>, path: string): Promise<void>;
|
|
154
|
+
/** Deletes every kept file of one purpose and record. */
|
|
155
|
+
export declare function deleteVisitorUploads(deps: Pick<VisitorUploadDeps, 'bucket'>, scope: VisitorUploadScope): Promise<void>;
|
|
156
|
+
/** The headers a kept file is served with. */
|
|
157
|
+
export declare function visitorUploadResponseHeaders(file: Pick<VisitorUploadFile, 'name' | 'contentType'>): Record<string, string>;
|
|
158
|
+
/** The response a gated route streams a kept file into. */
|
|
159
|
+
export interface VisitorUploadResponse extends Writable {
|
|
160
|
+
setHeader(name: string, value: string): void;
|
|
161
|
+
status(code: number): unknown;
|
|
162
|
+
}
|
|
163
|
+
/**
|
|
164
|
+
* Streams a kept file to a route's response, after the route has checked the
|
|
165
|
+
* caller. The file is never held whole in memory.
|
|
166
|
+
*/
|
|
167
|
+
export declare function sendVisitorUploadFile(deps: Pick<VisitorUploadDeps, 'bucket'>, res: VisitorUploadResponse, file: Pick<VisitorUploadFile, 'path' | 'name' | 'contentType'>): Promise<void>;
|