SourceControlProvider.php

<?php

namespace App\SourceControlProviders;

use App\Exceptions\FailedToDeployGitHook;
use App\Exceptions\FailedToDeployGitKey;
use App\Exceptions\FailedToDestroyGitHook;

interface SourceControlProvider
{
    public static function id(): string;

    /**
     * @param  array<string, mixed>  $input
     * @return array<string, mixed>
     */
    public function createRules(array $input): array;

    /**
     * @param  array<string, mixed>  $input
     * @return array<string, mixed>
     */
    public function createData(array $input): array;

    /**
     * @return array<string, mixed>
     */
    public function data(): array;

    public function connect(): bool;

    public function getRepo(string $repo): mixed;

    public function fullRepoUrl(string $repo, string $key): string;

    /**
     * @param  array<int, mixed>  $events
     * @return array<string, mixed>
     *
     * @throws FailedToDeployGitHook
     */
    public function deployHook(string $repo, array $events, string $secret): array;

    /**
     * @throws FailedToDestroyGitHook
     */
    public function destroyHook(string $repo, string $hookId): void;

    /**
     * @return array<string, mixed>|null
     */
    public function getLastCommit(string $repo, string $branch): ?array;

    /**
     * @throws FailedToDeployGitKey
     */
    public function deployKey(string $title, string $repo, string $key): string;

    public function deleteDeployKey(string $keyId, string $repo): void;

    /**
     * @param  array<string, mixed>  $payload
     */
    public function getWebhookBranch(array $payload): string;

    public function getRepos(bool $useCache = true): array;
    public function getBranches(string $repo, bool $useCache = true): array;
    public function getSshPort(): ?int;
}