mirror of
https://github.com/InvoiceShelf/InvoiceShelf.git
synced 2026-07-16 22:05:20 +00:00
Foundation for the AI chatbot + text generation feature. Phase 1 is infrastructure only: driver plumbing, configuration storage with encrypted API keys, global vs per-company resolution, admin + company UI pages, and an optional installer wizard step. The chat assistant and text-generation WYSIWYG integration come in later phases.
**Driver plumbing (app/Support/Ai/)** — AiDriver abstract, AiDriverFactory, AiException, AiChatResponse DTO, OpenRouterDriver concrete implementation. OpenRouter is the OpenAI-compatible aggregator that unlocks hundreds of models behind one API key and one request shape — ideal as the default v1 driver. Drivers are extensible the same way exchange rate drivers are: the module Registry's generic registerDriver('ai', ...) machinery plus a typed Registry::registerAiDriver() convenience wrapper (shipped in the upstream invoiceshelf/modules package in a paired commit).
**AiConfigurationService** — mirrors MailConfigurationService shape but with one deliberate deviation: API keys are encrypted at the service layer via Crypt::encryptString before persistence. OpenRouter bearer tokens have much bigger blast radius than SMTP passwords. Same settings / company_settings tables, same global-vs-per-company pattern, same use_custom_ai_config override toggle. Resolution order: global ai_enabled must be YES, then the company either overrides via use_custom_ai_config=YES (and can opt out with ai_enabled=NO inside the override) or inherits the global config.
**Controllers** — Admin/Settings/AiConfigurationController (global CRUD + driver list + test connection), Company/Settings/CompanyAiConfigurationController (per-company override + test), Setup/AiConfigurationController (installer wizard step, skippable with explicit ai_enabled=NO). API key is always masked as '********' in GET responses — the frontend submits the placeholder back on save and the backend preserves the stored value.
**Installer wizard** — new optional step 7 'AI' between Mail and Account. Default OFF with a Skip button. MailView.vue now routes to installation.ai instead of installation.account; installation.ai then routes to installation.account. Step order comment updated in routes.ts.
**Admin + Company settings pages** — AdminAiConfigView (no toggle, always global) and AiConfigView (with use_custom_ai_config BaseSwitchSection that auto-saves OFF). Both share AiConfigurationForm which renders the driver selector, API key input with show/hide, driver-specific config_fields (base_url for OpenRouter), and per-role enable toggles with free-text model inputs backed by a datalist of suggested models from driver metadata.
**Bootstrap endpoint** — adds an ai block to the response: { enabled, chat_enabled, text_generation_enabled }. All three are booleans resolved through AiConfigurationService::resolveForCompany(). Never leaks the API key. Frontend feature flags read from bootstrapData.ai to decide whether to show Phase 2/3 UI.
**Bouncer ability** 'manage ai config' added to SettingsPolicy, gated on isSuperAdmin() (same pattern as manage email config, manage pdf config).
**Tests** (22 new) — Unit: AiDriverFactory resolves built-in + Registry-contributed drivers, rejects unknown, merges availableDrivers. AiConfigurationService: encryption round-trip, resolution order (3 cases: global off, inherit global, override with company key, override with opt-out), makeDriver null/instance cases, listDrivers metadata. Feature: admin save + read with api key masking, preserve-on-placeholder behavior, company toggle ON/OFF semantics, bootstrap ai flags reflect resolution, company opt-out path.
372 tests pass (was 350, +22). Pint clean. npm run build clean. Phase 2 (chat assistant + tool calling) and Phase 3 (WYSIWYG text generation popup) are separate follow-up commits — this one is the foundation only.
87 lines
2.7 KiB
PHP
87 lines
2.7 KiB
PHP
<?php
|
|
|
|
namespace App\Support\Ai;
|
|
|
|
use InvalidArgumentException;
|
|
use InvoiceShelf\Modules\Registry;
|
|
|
|
/**
|
|
* Instantiates AiDriver implementations by name.
|
|
*
|
|
* Mirrors the shape of ExchangeRateDriverFactory: a static $drivers fallback
|
|
* map for built-ins registered directly against the factory, plus a fallback
|
|
* to the module Registry so module-contributed drivers (via
|
|
* Registry::registerAiDriver()) are also resolvable. Canonical registration
|
|
* path is the Registry — the local fallback map exists so the factory keeps
|
|
* working even in tests or contexts where the Registry happens to be flushed.
|
|
*/
|
|
class AiDriverFactory
|
|
{
|
|
/**
|
|
* @var array<string, class-string<AiDriver>>
|
|
*/
|
|
protected static array $drivers = [
|
|
'openrouter' => OpenRouterDriver::class,
|
|
];
|
|
|
|
/**
|
|
* Register a custom AI driver directly with the factory.
|
|
*
|
|
* Modules should prefer Registry::registerAiDriver() which carries
|
|
* the metadata (label, website, supported_roles, suggested_models,
|
|
* config_fields) that the frontend UI needs to render a configuration
|
|
* form. This method exists for tests and programmatic registration.
|
|
*
|
|
* @param class-string<AiDriver> $driverClass
|
|
*/
|
|
public static function register(string $name, string $driverClass): void
|
|
{
|
|
static::$drivers[$name] = $driverClass;
|
|
}
|
|
|
|
/**
|
|
* Instantiate a driver by name.
|
|
*
|
|
* @param array<string, mixed> $config Driver-specific config (base_url, timeouts, etc.)
|
|
*
|
|
* @throws InvalidArgumentException When the driver name isn't known.
|
|
*/
|
|
public static function make(string $driver, string $apiKey, array $config = []): AiDriver
|
|
{
|
|
$class = static::resolveDriverClass($driver);
|
|
|
|
if (! $class) {
|
|
throw new InvalidArgumentException("Unknown AI driver: {$driver}");
|
|
}
|
|
|
|
return new $class($apiKey, $config);
|
|
}
|
|
|
|
/**
|
|
* Get all known driver names — both factory-registered built-ins and Registry-contributed.
|
|
*
|
|
* @return array<int, string>
|
|
*/
|
|
public static function availableDrivers(): array
|
|
{
|
|
$local = array_keys(static::$drivers);
|
|
$registry = array_keys(Registry::allDrivers('ai'));
|
|
|
|
return array_values(array_unique(array_merge($local, $registry)));
|
|
}
|
|
|
|
/**
|
|
* Resolve a driver name to its concrete class via the local map then the Registry.
|
|
*/
|
|
protected static function resolveDriverClass(string $driver): ?string
|
|
{
|
|
if (isset(static::$drivers[$driver])) {
|
|
return static::$drivers[$driver];
|
|
}
|
|
|
|
$meta = Registry::driverMeta('ai', $driver);
|
|
|
|
return $meta['class'] ?? null;
|
|
}
|
|
}
|