@digitalpersona/enrollment/src/enrollmentContext.ts

DigitalPersona Enrollment API

import { User, JSONWebToken } from '@digitalpersona/core';
import { IEnrollService } from '@digitalpersona/services';

/**
 * Enrollment context.
 * @remarks
 * Pass the context object into token enrollment APIs. The single context may be shared.
 */
export class EnrollmentContext
{
    constructor(
        /** DigitalPersona Enrollment web service client */
        public readonly enrollService: IEnrollService,
        /** A JSON Web Token or a username of a user whose credentials are to be enrolled.
         * @remarks
         * Only DigitalPersona users (formerly "Altus User") can be enrolled without authentication,
         * i.e. using only a user name. Other users must be authenticated, i.e. have a JSON Web Token.
         */
        public user: JSONWebToken | User,
        /** An optional JSON Web Token of a security officer performing an attended enrollment.
         * If not provided, the API should try to use a user's own token instead for a self-enrollment.
         * In this case the user must be allowed to do self-enrollment.
         */
        public securityOfficer?: JSONWebToken,
    ){
        if (!this.enrollService)
            throw new Error("enrollService");
        if (!this.user)
            throw new Error("user");
        if (!this.securityOfficer && !(this.user instanceof User))
            this.securityOfficer = this.user;
    }

    /**
     * Check is the user has an authentication token, or just a user name.
     * @returns `true` if user identity represented by an authenticatication token, `false` otherwise.
     */
    public isAuthenticated(): boolean {
        return !(this.user instanceof User);
    }
    /**
     * Returns user identity in a form of authentication token.
     * @remarks
     * The user must be authenticated.
     */
    public getJWT(): JSONWebToken
    {
        return (this.user instanceof User) ? "" : this.user;
    }

    /**
     * Returns user identity in a form of a username.
     * @remarks
     * The user may be authenticated or not. If authenticated, the username will be produced from
     * the authentication token claims.
     */
    public getUser(): User
    {
        return (this.user instanceof User) ? this.user : User.fromJWT(this.user);
    }
}