iya-sts
    Preparing search index...

    The description pages' runtime.

    Hierarchy (View Summary)

    Index
    • Makes the runtime for the page the shell carries.

      Parameters

      • env: any

        the browser's objects

      Returns export=

    accountChannel: any
    accounts: any
    drawn: number
    drawnAt: string
    elsewhere: any
    env: any
    flash: any
    formTable: any
    i18n: export=
    lastAnswer: any
    options: SurfaceOptions
    prefix: string
    row: any
    t: any
    view: any
    NO_ACCOUNT_CONTROL: string[] = ...
    • The account control for the page being drawn: '' with the list off and on a path that never carries it.

      Returns string

      the control in its slot, or ''

    • Draws what an act answered.

      Parameters

      • path: string

        the surface's path the form was on

      • answer: any

        { status, json }

      Returns Promise<void>

      nothing

    • The context a renderer is handed.

      Parameters

      • query: any

        the location's query

      Returns any

      the context

    • Draws a page that says something went wrong: in English, as every refusal here is.

      Parameters

      • title: string

        what went wrong

      • detail: string

        the detail

      Returns void

      nothing

    • Draws the page in hand from its view, with what an act left to say.

      Returns void

      nothing

    • The operation table, once: which operation each form goes to.

      Returns Promise<boolean>

      whether it is in hand

    • The page row for a path.

      Parameters

      • path: string

        the surface's path

      Returns SurfacePage

      the row, or null

    • A form's fields as an object: a repeated name is an array, the pressed button's name and value are included, and the CSRF field a form drawn by the server carried is left out (an API call is not a form post).

      Parameters

      • form: any

        the form element

      • submitter: any

        the button pressed, if any

      Returns any

      the fields

    • Goes to one of the surface's paths, adding it to the history.

      Parameters

      • to: string

        the path and query under the realm

      Returns Promise<void>

      nothing

    • The path and query being shown, without the realm prefix.

      Returns string

      the path and query

    • Reads the browser's account list as the surface starts; with it on, the control's words are loaded with the page's and other tabs' changes are listened for.

      Returns Promise<void>

      nothing

    • Leaves every link to the browser: each endpoint a page names is answered by the server, never drawn in place.

      Parameters

      • event: any

        the click

      Returns void

      nothing

    • Handles a submitted form: the language chooser, a GET form's navigation, or an act.

      Parameters

      • event: any

        the submit event

      Returns void

      nothing

    • The parameters this page was reached with.

      Returns any

      them

    • Calls an operation that takes no token, sending an object as JSON, and reads its JSON.

      Parameters

      • method: string

        GET or POST

      • path: string

        the path under the realm

      • Optionalbody: any

        for a POST, an object

      • Optionalheaders: any

      Returns Promise<any>

      { status, json, res }, json null where the body was not JSON

    • Puts a page in the document, with the chooser, and wires it.

      Parameters

      • title: string

        the document's title, as text

      • body: string

        the page's body

      • ctx: any

        the context it was drawn with

      Returns void

      nothing

    • Draws the page in hand again in the language just chosen, from the view in hand: there is no operation to fetch it again from.

      Returns void

      nothing

    • Reads the list again and draws the control again in place; a change this page's own act made is announced to the other tabs.

      Parameters

      • announce: boolean

        whether a change is this page's to announce (never when a message asked)

      Returns Promise<void>

      nothing

    • Draws the page the shell carries.

      Returns Promise<void>

      nothing

    • Saves a file an answer carried as base64.

      Parameters

      • name: string

        its file name

      • mime: string

        its media type

      • base64: string

        its bytes

      Returns void

      nothing

    • Hands a blob to the browser as a download.

      Parameters

      • name: string

        the file's name

      • blob: Blob

        its contents

      Returns void

      nothing

    • Saves text as a file.

      Parameters

      • name: string

        the file's name

      • mime: string

        its media type

      • text: string

        its contents

      Returns void

      nothing

    • Starts the surface: wires the document and draws the first page.

      Returns Promise<void>

      nothing

    • Refuses a form these pages do not have: nothing here is sent.

      Parameters

      • form: any

        the form

      • submitter: any

        the button pressed, if any

      Returns Promise<void>

      nothing

    • The surface's path of a full path under this realm, or null for one that is not the surface's.

      Parameters

      • pathname: string

        the path

      Returns string

      the path without the prefix, or null

    • Makes the address's fragment the :target of the page just drawn.

      Returns void

      nothing

    • This realm's address for one of its paths: on this origin, or on the listener that answers the path where the shell named one.

      Parameters

      • path: string

        /oauth2/token, /web/locales/catalogs.json

      Returns string

      the absolute URL

    • One attribute of the shell's <html> element.

      Parameters

      • env: any

        the browser's objects

      • name: string

        the attribute, data-sts-build

      Returns string

      its value, or '' where it is absent

    • Reads the shell's data-sts-* attributes into bases by path segment.

      Parameters

      • env: any

        the browser's objects; its document is read

      • attributes: Record<string, string>

        the attribute for each first path segment

      Returns any

      the bases, without a trailing slash, '' where absent

    • The brand header's markup, as common/branding.ts's headerMarkup() draws it on the server (its preview): the logo, a link where one is set, and the name, each escaped; empty where there is neither.

      Parameters

      • brand: any

        brandOf()'s facts

      Returns string

      the markup

    • The realm's brand facts the shell put on <html> (#717): the name, the logo's address, its alternative text and its link.

      Parameters

      • root: any

        the document's <html> element, or nothing

      Returns any

      the facts, each '' where absent

    • The state the shell carried, or null where it carried none or it does not read.

      Parameters

      • env: any

        the browser's objects

      Returns any

      { view }, or null

    • Escapes text for HTML, as Html.esc() does.

      Parameters

      • value: unknown

        anything

      Returns string

      the escaped text

    • The surface's options for a page row: its path the base, its namespace the one loaded.

      Parameters

      • row: any

        the row, or null

      Returns any

      the options

    • Splits a path at a surface's base: the realm prefix before it.

      Parameters

      • pathname: string

        a path, /realm/acme/portal/keys or /portal

      • base: string

        the surface's first path, /portal

      Returns string

      the prefix, '' in the default realm and where the path is not under the base

    • Parses a query string into an object, the last value of a repeated name winning as express's own parser does for a single value.

      Parameters

      • search: string

        ?a=1&b=2 or ''

      Returns any

      the query

    • Prefixes every root-relative href, action, formaction and src.

      Parameters

      • html: string

        the page

      • prefix: string

        the realm's path prefix, or '' for the default realm

      Returns string

      the page with its links in the realm

    • The page row a state's view names.

      Parameters

      • state: any

        the shell's state, or null

      Returns any

      the row, or null

    • Moves a sign-in step's id from a link's query to its fragment (#1454). /authn/spnego stays: RFC 4559's exchange has no script to read one.

      Parameters

      • href: string

        the link

      Returns string

      the link to use

    • Takes a step's id off an API address, for a header (#1454).

      Parameters

      • path: string

        the operation's address

      Returns any

      the address, and the headers that carry what left it