strapi/packages/core/admin/shared/contracts/audit-logs.ts

import { errors } from '@strapi/utils';
import { Entity, Pagination, SanitizedAdminUser } from './shared';

// displayName seems to be used only for audit logs
export interface SanitizedAdminUserForAuditLogs extends SanitizedAdminUser {
  displayName: string;
}

interface AuditLog extends Pick<Entity, 'id'> {
  date: string;
  action: string;
  /**
   * TODO: could this be better typed – working on the server-side code could indicate this.
   * However, we know it's JSON.
   */
  payload: Record<string, unknown>;
  user?: SanitizedAdminUserForAuditLogs;
}

namespace GetAll {
  export interface Request {
    body: {};
    query: {};
  }

  export type Response =
    | {
        pagination: Pagination;
        results: AuditLog[];
        error?: never;
      }
    | {
        pagination?: never;
        results?: never;
        error?: errors.ApplicationError;
      };
}

namespace Get {
  export interface Request {
    body: {};
    query: {};
  }

  export interface Params {
    id: Entity['id'];
  }

  export type Response =
    | AuditLog
    | {
        error?: errors.ApplicationError;
      };
}

export { AuditLog, GetAll, Get };