// Copyright Inrupt Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal in
// the Software without restriction, including without limitation the rights to use,
// copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
// Software, and to permit persons to whom the Software is furnished to do so,
// subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
// PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
// SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//

import type { EventEmitter } from "events";
import type { KeyPair } from "../../../authenticatedFetch/dpopUtils";

/**
 * Based on openid-client's TokenSetParameters. Re-creating the type allows not
 * to depend on the Node-specific library at the environment-agnostic level.
 */
export type TokenEndpointResponse = {
  /**
   * JWT-serialized access token
   */
  accessToken: string;
  /**
   * Usually "Bearer"
   */
  tokenType?: "Bearer" | "DPoP";
  /**
   * JWT-serialized id token
   */
  idToken?: string;
  /**
   * URL identifying the subject of the ID token.
   */
  webId?: string;
  /**
   * Refresh token (not necessarily a JWT)
   */
  refreshToken?: string;

  /**
   * Expiration of the access token.
   */
  expiresAt?: number;

  /**
   * ExpiresAt should be computed from expiresIn when receiving the token.
   */
  expiresIn?: number;

  /**
   * DPoP key to which the access token, and potentially the refresh token, are bound.
   */
  dpopKey?: KeyPair;
};

export interface ITokenRefresher {
  refresh(
    localUserId: string,
    refreshToken?: string,
    dpopKey?: KeyPair,
    eventEmitter?: EventEmitter,
  ): Promise<TokenEndpointResponse>;
}