@wildboar/pki-stub/src/lib/modules/InformationFramework/Context.ta.d.ts

X.510 PKI-Stub ASN.1 data structures in TypeScript

import { ASN1Element as _Element, BOOLEAN, OBJECT_IDENTIFIER, OPTIONAL } from "asn1-ts";
import * as $ from "asn1-ts/dist/node/functional";
/**
 * @summary Context
 * @description
 *
 * ### ASN.1 Definition:
 *
 * ```asn1
 * Context ::= SEQUENCE {
 *   contextType    CONTEXT.&id({SupportedContexts}),
 *   contextValues
 *     SET SIZE (1..MAX) OF CONTEXT.&Type({SupportedContexts}{@contextType}),
 *   fallback       BOOLEAN DEFAULT FALSE,
 *   ... }
 * ```
 *
 * @class
 */
export declare class Context {
    /**
     * @summary `contextType`.
     * @public
     * @readonly
     */
    readonly contextType: OBJECT_IDENTIFIER;
    /**
     * @summary `contextValues`.
     * @public
     * @readonly
     */
    readonly contextValues: _Element[];
    /**
     * @summary `fallback`.
     * @public
     * @readonly
     */
    readonly fallback?: OPTIONAL<BOOLEAN>;
    /**
     * @summary Extensions that are not recognized.
     * @public
     * @readonly
     */
    readonly _unrecognizedExtensionsList: _Element[];
    constructor(
    /**
     * @summary `contextType`.
     * @public
     * @readonly
     */
    contextType: OBJECT_IDENTIFIER, 
    /**
     * @summary `contextValues`.
     * @public
     * @readonly
     */
    contextValues: _Element[], 
    /**
     * @summary `fallback`.
     * @public
     * @readonly
     */
    fallback?: OPTIONAL<BOOLEAN>, 
    /**
     * @summary Extensions that are not recognized.
     * @public
     * @readonly
     */
    _unrecognizedExtensionsList?: _Element[]);
    /**
     * @summary Restructures an object into a Context
     * @description
     *
     * This takes an `object` and converts it to a `Context`.
     *
     * @public
     * @static
     * @method
     * @param {Object} _o An object having all of the keys and values of a `Context`.
     * @returns {Context}
     */
    static _from_object(_o: {
        [_K in keyof Context]: Context[_K];
    }): Context;
    /**
     * @summary Getter that returns the default value for `fallback`.
     * @public
     * @static
     * @method
     */
    static get _default_value_for_fallback(): boolean;
}
/**
 * @summary The Leading Root Component Types of Context
 * @description
 *
 * This is an array of `ComponentSpec`s that define how to decode the leading root component type list of a SET or SEQUENCE.
 *
 * @constant
 */
export declare const _root_component_type_list_1_spec_for_Context: $.ComponentSpec[];
/**
 * @summary The Trailing Root Component Types of Context
 * @description
 *
 * This is an array of `ComponentSpec`s that define how to decode the trailing root component type list of a SET or SEQUENCE.
 *
 * @constant
 */
export declare const _root_component_type_list_2_spec_for_Context: $.ComponentSpec[];
/**
 * @summary The Extension Addition Component Types of Context
 * @description
 *
 * This is an array of `ComponentSpec`s that define how to decode the extension addition component type list of a SET or SEQUENCE.
 *
 * @constant
 */
export declare const _extension_additions_list_spec_for_Context: $.ComponentSpec[];
/**
 * @summary Decodes an ASN.1 element into a(n) Context
 * @function
 * @param {_Element} el The element being decoded.
 * @returns {Context} The decoded data structure.
 */
export declare function _decode_Context(el: _Element): Context;
/**
 * @summary Encodes a(n) Context into an ASN.1 Element.
 * @function
 * @param {value} el The element being decoded.
 * @param elGetter A function that can be used to get new ASN.1 elements.
 * @returns {_Element} The Context, encoded as an ASN.1 Element.
 */
export declare function _encode_Context(value: Context, elGetter: $.ASN1Encoder<Context>): _Element;