token-guardian/src/interfaces/RotationResult.ts

A comprehensive solution for protecting and managing API tokens and secrets

/**
 * Result of a token rotation operation
 */
export interface RotationResult {
  /**
   * Whether the rotation was successful
   */
  success: boolean;
  
  /**
   * Message explaining the result
   */
  message: string;
  
  /**
   * New token value (if rotation succeeded)
   */
  newToken?: string;
  
  /**
   * Expiration date of the new token
   */
  newExpiry: Date | null;

  /**
   * Warning messages (if any)
   */
  warnings?: string[];

  /**
   * Additional metadata about the rotation
   */
  metadata?: Record<string, unknown>;
}