@wildboar/pki-stub/src/lib/modules/PkiPmiExternalDataTypes/PersonalName.ta.d.ts

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

import { ASN1Element as _Element, OPTIONAL, PrintableString } from "asn1-ts";
import * as $ from "asn1-ts/dist/node/functional";
/**
 * @summary PersonalName
 * @description
 *
 * ### ASN.1 Definition:
 *
 * ```asn1
 * PersonalName ::= SET {
 *   surname               [0]  PrintableString(SIZE (1..ub-surname-length)),
 *   given-name
 *     [1]  PrintableString(SIZE (1..ub-given-name-length)) OPTIONAL,
 *   initials
 *     [2]  PrintableString(SIZE (1..ub-initials-length)) OPTIONAL,
 *   generation-qualifier
 *     [3]  PrintableString(SIZE (1..ub-generation-qualifier-length)) OPTIONAL }
 * ```
 *
 * @class
 */
export declare class PersonalName {
    /**
     * @summary `surname`.
     * @public
     * @readonly
     */
    readonly surname: PrintableString;
    /**
     * @summary `given_name`.
     * @public
     * @readonly
     */
    readonly given_name?: OPTIONAL<PrintableString>;
    /**
     * @summary `initials`.
     * @public
     * @readonly
     */
    readonly initials?: OPTIONAL<PrintableString>;
    /**
     * @summary `generation_qualifier`.
     * @public
     * @readonly
     */
    readonly generation_qualifier?: OPTIONAL<PrintableString>;
    constructor(
    /**
     * @summary `surname`.
     * @public
     * @readonly
     */
    surname: PrintableString, 
    /**
     * @summary `given_name`.
     * @public
     * @readonly
     */
    given_name?: OPTIONAL<PrintableString>, 
    /**
     * @summary `initials`.
     * @public
     * @readonly
     */
    initials?: OPTIONAL<PrintableString>, 
    /**
     * @summary `generation_qualifier`.
     * @public
     * @readonly
     */
    generation_qualifier?: OPTIONAL<PrintableString>);
    /**
     * @summary Restructures an object into a PersonalName
     * @description
     *
     * This takes an `object` and converts it to a `PersonalName`.
     *
     * @public
     * @static
     * @method
     * @param {Object} _o An object having all of the keys and values of a `PersonalName`.
     * @returns {PersonalName}
     */
    static _from_object(_o: {
        [_K in keyof PersonalName]: PersonalName[_K];
    }): PersonalName;
}
/**
 * @summary The Leading Root Component Types of PersonalName
 * @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_PersonalName: $.ComponentSpec[];
/**
 * @summary The Trailing Root Component Types of PersonalName
 * @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_PersonalName: $.ComponentSpec[];
/**
 * @summary The Extension Addition Component Types of PersonalName
 * @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_PersonalName: $.ComponentSpec[];
/**
 * @summary Decodes an ASN.1 element into a(n) PersonalName
 * @function
 * @param {_Element} el The element being decoded.
 * @returns {PersonalName} The decoded data structure.
 */
export declare function _decode_PersonalName(el: _Element): PersonalName;
/**
 * @summary Encodes a(n) PersonalName 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 PersonalName, encoded as an ASN.1 Element.
 */
export declare function _encode_PersonalName(value: PersonalName, elGetter: $.ASN1Encoder<PersonalName>): _Element;