iya-sts
    Preparing search index...

    Class export=

    One XML family's facts, and the readers and writers built from them.

    Index
    • Builds the reader over generated files, merged: their ids are disjoint by family (models/lib/saml_lib.mjs's FAMILIES).

      Parameters

      • files: string[]

        the generated files, such as ['ws.json', 'saml.json']

      • family: string

        the family's name, for the sentences

      Returns export=

    • The values an attribute a request carries is held to.

      Parameters

      • id: string

        the message

      • name: string

        the attribute's name in the model

      Returns string[]

      the values; empty when it is held to none

    • One attribute of a message, by its name in the model.

      Parameters

      • id: string

        the message

      • name: string

        the attribute's name in the model

      Returns Json

      the attribute

    • A start tag's attributes, IN THE MODEL'S ORDER: Name="value" for each, its value escaped, a fixed value always, and nothing for a value that is undefined, null or empty. A name the model does not declare, or one it says this service does not write, throws.

      Parameters

      • id: string

        the message

      • values: Record<string, unknown>

        the values, by each attribute's name in the model

      Returns string

      the text to follow the element's name (and its namespace declarations)

    • The local names of a message's children a flag marks, in the model's order.

      Parameters

      • id: string

        the message

      • flag: string

        the flag, such as read or anotherPartys

      Returns string[]

      the local names

    • The child elements' text joined IN THE MODEL'S ORDER. A part the model does not name, or one it says the builder never writes, throws.

      Parameters

      • id: string

        the message

      • parts: Record<string, string>

        each child's text, by its name in the model

      Returns string

      the content

    • One child element of a message, by its name in the model.

      Parameters

      • id: string

        the message

      • name: string

        the child's name in the model

      Returns Json

      the child

    • The map from one vocabulary's terms to the other's by equivalent.

      Parameters

      • from: string

        the vocabulary whose terms name an equivalent

      • to: string

        the vocabulary the equivalent is a term of

      Returns Record<string, string>

      the map

    • HOLDS a document this service built to its message: what does not match is recorded under code and the document is answered as it was built — the model describes the wire and does not reshape it, so this is a model gap to close.

      Parameters

      • id: string

        the message

      • xml: string

        the document

      • where: string

        what is being sent, for the log

      • code: string

        the error code a gap is recorded under

      • directory: string

        where the family's model is, for the log

      • Optionaldeclarations: Record<string, string>

        a fragment's prefixes, as problems() takes them

      Returns string

      the document, unchanged

    • One message.

      Parameters

      • id: string

        its id, such as saml2.AuthnRequest

      Returns Json

      the message

    • One parameter of a parameter set.

      Parameters

      • id: string

        the set, such as saml11.browser

      • name: string

        the parameter's name in the model

      Returns Json

      the parameter

    • The wire names of a parameter set's parameters, those whose use is the one named when one is.

      Parameters

      • id: string

        the set

      • Optionaluse: string

        the use, or nothing for every parameter

      Returns string[]

      the wire names, in the model's order

    • The vocabulary's prefix, where the model gives one.

      Parameters

      • id: string

        the vocabulary

      Returns string

      the prefix

    • What is wrong with a document this service built, against the message its root is.

      Parameters

      • id: string

        the message

      • xml: string

        the document

      • Optionaldeclarations: Record<string, string>

        for a FRAGMENT whose prefixes are declared by the document it is put in (a metadata role inside an EntityDescriptor): those prefixes' namespaces, by prefix

      Returns string[]

      the problems; empty when there are none

    • What is wrong with a built element, against its message: the element's name and namespace, an attribute the model does not declare or says this service does not write, a fixed value not written, a required attribute missing, a child the model does not name or that is out of the model's order, one repeated that may not be, a required child missing — and the same of every child that is a declared message.

      Parameters

      • id: string

        the message

      • element: any

        the parsed element

      • where: string

        the element's path, for the sentences

      Returns string[]

      the problems; empty when there are none

    • A parsed element's attributes, as the model reads each: an xs:boolean by XML Schema Part 2 section 3.2.2, true for "true" or "1" after its whitespace is collapsed (rcbj on #1579, 2026-11-11; until then "1" read as false), anything else is its text or '' when absent. Only the attributes the model marks read.

      Parameters

      • id: string

        the message the element is

      • element: any

        the parsed element

      Returns Record<string, any>

      the values, by each attribute's name in the model

    • One term's value.

      Parameters

      • id: string

        the vocabulary

      • name: string

        the term's name in the model

      Returns string

      its value on the wire

    • One term.

      Parameters

      • id: string

        the vocabulary

      • name: string

        the term's name in the model

      Returns Json

      the term, its value and flags

    • The values of a vocabulary's terms, in the model's order, those a flag marks when one is named (a flag with a value: those it has that value for).

      Parameters

      • id: string

        the vocabulary

      • Optionalflag: string

        the flag, or nothing for every term

      • Optionalvalue: unknown

        the flag's value, or nothing for any true one

      Returns string[]

      the values

    • One vocabulary.

      Parameters

      • id: string

        its id, such as saml2.status

      Returns Json

      the vocabulary

    • Whether an xs:boolean's text is true: XML Schema Part 2 section 3.2.2's lexical space is {true, false, 1, 0}, its whitespace collapsed. Anything else, absence included, is not true.

      Parameters

      • raw: unknown

        the attribute's or element's text

      Returns boolean

      true for "true" and "1"

    • The same characters common/helpers.js's xmlEscape() writes, for an attribute's value.

      Parameters

      • value: unknown

      Returns string