<?php

declare(strict_types=1);

/**
 * SPDX-FileCopyrightText: Sebastian Krupinski <krupinski01@gmail.com>
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */

namespace KTXF\Chrono\Provider;

use JsonSerializable;
use KTXF\Chrono\Service\IServiceBase;

interface IProviderBase extends JsonSerializable {

	public const CAPABILITY_SERVICE_LIST = 'ServiceList';
	public const CAPABILITY_SERVICE_FETCH = 'ServiceFetch';
	public const CAPABILITY_SERVICE_EXTANT = 'ServiceExtant';

	public const JSON_TYPE = 'chrono.provider';
	public const JSON_PROPERTY_TYPE = '@type';
	public const JSON_PROPERTY_ID = 'id';
	public const JSON_PROPERTY_LABEL = 'label';
	public const JSON_PROPERTY_CAPABILITIES = 'capabilities';

	/**
	 * Confirms if specific capability is supported (e.g. 'ServiceList')
	 *
	 * @since 2025.05.01
	 */
	public function capable(string $value): bool;

	/**
	 * Lists all supported capabilities
	 *
	 * @since 2025.05.01
	 *
	 * @return array<string,bool>
	 */
	public function capabilities(): array;

	/**
	 * An arbitrary unique text string identifying this provider (e.g. UUID or 'system' or anything else)
	 *
	 * @since 2025.05.01
	 */
	public function id(): string;

	/**
	 * The localized human friendly name of this provider (e.g. System Calendar Provider)
	 *
	 * @since 2025.05.01
	 */
	public function label(): string;

	/**
	 * Retrieve collection of services for a specific user
	 *
	 * @since 2025.05.01
	 *
	 * @param string $tenantId tenant identifier
	 * @param string $userId user identifier
	 * @param array $filter filter criteria
	 *
	 * @return array<string,IServiceBase> collection of service objects
	 */
	public function serviceList(string $tenantId, string $userId, array $filter): array;

	/**
	 * Determine if any services are configured for a specific user
	 *
	 * @since 2025.05.01
	 *
	 * @param string $tenantId tenant identifier
	 * @param string $userId user identifier
	 * @param int|string ...$identifiers variadic collection of service identifiers
	 * 
	 * @return array<string,bool> collection of service identifiers with boolean values indicating if the service is available
	 */
	public function serviceExtant(string $tenantId, string $userId, int|string ...$identifiers): array;

	/**
	 * Retrieve a service with a specific identifier
	 *
	 * @since 2025.05.01
	 *
	 * @param string $tenantId tenant identifier
	 * @param string $userId user identifier
	 * @param string|int $identifier service identifier
	 *
	 * @return IServiceBase|null returns service object or null if non found
	 */
	public function serviceFetch(string $tenantId, string $userId, string|int $identifier): ?IServiceBase;

}