@citrineos/util/dist/authorization/authorization.d.ts

The OCPP util module which supplies helpful utilities like cache and queue connectors, etc.

import { IMessageContext, OCPP2_0_1 } from '@citrineos/base';
import { Authorization } from '@citrineos/data';
export interface IAuthorizer {
    /**
     * Interface for adding additional authorization logic.
     * The Partial IdTokenInfoType is used to update the IdTokenInfo in the AuthorizeResponse or TransactionEventResponse.
     * If IdTokenInfoType.status is not Accepted, the authorization process will stop and the rejection put into the response.
     * The order of Authorizers can lead to different outputs; instantiate them in the order they should be called.
     *
     * @param {Authorization} authorization The authorization object associated with the idToken in the request. No modifications should be made to this object.
     * @param {IMessageContext} context
     *
     * @returns {Promise<Partial<IdTokenInfoType>>} Updates to the IdTokenInfo
     **/
    authorize(authorization: Authorization, context: IMessageContext): Promise<Partial<OCPP2_0_1.IdTokenInfoType>>;
}