breadcrumb-the-shire/core/Repository/Auth/ApiTokenRepositoryInterface.php

<?php

namespace MintyPHP\Repository\Auth;

/** Contract for API bearer token creation, lookup by selector or UUID, and revocation. */
interface ApiTokenRepositoryInterface
{
    public function isUuid(string $value): bool;

    public function create(
        int $userId,
        string $name,
        string $selector,
        string $tokenHash,
        ?int $tenantId,
        ?string $expiresAt,
        ?int $createdBy
    ): ?int;

    public function findBySelector(string $selector): ?array;

    public function find(int $id): ?array;

    public function findByUuid(string $uuid): ?array;

    public function findByUuidForUser(string $uuid, int $userId): ?array;

    public function updateLastUsed(int $id, string $ip): bool;

    public function revoke(int $id): bool;

    public function revokeByUuidForUser(string $uuid, int $userId): bool;

    public function revokeAllForUser(int $userId, ?int $tenantId = null): int;

    public function revokeAllActiveByAdmin(): int;

    public function listByUserId(int $userId, int $limit = 25): array;

    public function countActiveForUser(int $userId): int;

    public function countActiveForUserExcludingId(int $userId, int $excludeId): int;

    public function countActive(): int;
}