PublicOriginResolver
Defined in: packages/core/src/models/public-origin.ts:39
Resolves the public origin; reads the database at most once per ttlMs.
Methods
Section titled “Methods”authOrigin()
Section titled “authOrigin()”authOrigin(
requestOrigin):Promise<string>
Defined in: packages/core/src/models/public-origin.ts:52
The origin for an interactive authentication route (OAuth redirect URI, OIDC helper): the
resolved origin, else requestOrigin, the address the request itself came in on. Never use
it for a link that outlives the request.
Parameters
Section titled “Parameters”requestOrigin
Section titled “requestOrigin”string
Returns
Section titled “Returns”Promise<string>
clear()
Section titled “clear()”clear():
Promise<void>
Defined in: packages/core/src/models/public-origin.ts:63
An admin dropped the stored origin.
Returns
Section titled “Returns”Promise<void>
report()
Section titled “report()”report(
origin,userId?):Promise<StoredPublicOrigin>
Defined in: packages/core/src/models/public-origin.ts:59
An admin’s browser reported origin. First report wins: nothing is stored when a value already
is, so a visit through another domain cannot replace a confirmed origin. Returns what is stored.
Parameters
Section titled “Parameters”origin
Section titled “origin”string
userId?
Section titled “userId?”string
Returns
Section titled “Returns”Promise<StoredPublicOrigin>
resolve()
Section titled “resolve()”resolve():
Promise<ResolvedPublicOrigin|null>
Defined in: packages/core/src/models/public-origin.ts:44
The origin background code may use now, or null when nothing is confirmed: a configured or
platform origin, or one an admin confirmed. A detected, unconfirmed origin never resolves.
Returns
Section titled “Returns”Promise<ResolvedPublicOrigin | null>
set(
origin,userId?):Promise<StoredPublicOrigin>
Defined in: packages/core/src/models/public-origin.ts:61
An admin confirmed or entered origin: it replaces whatever is stored.
Parameters
Section titled “Parameters”origin
Section titled “origin”string
userId?
Section titled “userId?”string
Returns
Section titled “Returns”Promise<StoredPublicOrigin>
stored()
Section titled “stored()”stored():
Promise<StoredPublicOrigin|null>
Defined in: packages/core/src/models/public-origin.ts:54
The value the System page shows and edits; null when no browser reported one.
Returns
Section titled “Returns”Promise<StoredPublicOrigin | null>
url():
Promise<string|undefined>
Defined in: packages/core/src/models/public-origin.ts:46
Shorthand for resolve() when only the URL matters.
Returns
Section titled “Returns”Promise<string | undefined>