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.
113 lines
3.5 KiB
PHP
113 lines
3.5 KiB
PHP
<?php
|
|
|
|
namespace App\Http\Controllers\Company\Settings;
|
|
|
|
use App\Http\Controllers\Controller;
|
|
use App\Services\AiConfigurationService;
|
|
use App\Support\Ai\AiDriverFactory;
|
|
use App\Support\Ai\AiException;
|
|
use Illuminate\Http\JsonResponse;
|
|
use Illuminate\Http\Request;
|
|
use Illuminate\Validation\ValidationException;
|
|
|
|
class CompanyAiConfigurationController extends Controller
|
|
{
|
|
public function __construct(
|
|
private readonly AiConfigurationService $aiConfigurationService,
|
|
) {}
|
|
|
|
/**
|
|
* Get the per-company AI config with decrypted API key masked for response.
|
|
*/
|
|
public function getConfig(Request $request): JsonResponse
|
|
{
|
|
$config = $this->aiConfigurationService->getCompanyConfig($request->header('company'));
|
|
|
|
return response()->json($this->maskApiKey($config));
|
|
}
|
|
|
|
/**
|
|
* Persist the per-company AI config.
|
|
*
|
|
* Respects the `use_custom_ai_config` toggle — when OFF, only the toggle is written
|
|
* and the driver fields are discarded (same pattern as the mail company override).
|
|
*
|
|
* @throws ValidationException
|
|
*/
|
|
public function saveConfig(Request $request): JsonResponse
|
|
{
|
|
$this->authorize('owner only');
|
|
|
|
$validated = $this->validate(
|
|
$request,
|
|
$this->aiConfigurationService->validationRules(allowDisabledCustomConfig: true),
|
|
);
|
|
|
|
// Preserve existing key when masked placeholder is submitted
|
|
if (($validated['ai_api_key'] ?? null) === '********' || ($validated['ai_api_key'] ?? null) === '') {
|
|
$existing = $this->aiConfigurationService->getCompanyConfig($request->header('company'));
|
|
$validated['ai_api_key'] = $existing['ai_api_key'] ?? '';
|
|
}
|
|
|
|
$this->aiConfigurationService->saveCompanyConfig(
|
|
$request->header('company'),
|
|
$validated,
|
|
);
|
|
|
|
return response()->json(['success' => true]);
|
|
}
|
|
|
|
/**
|
|
* Test a company-level AI configuration without persisting it.
|
|
*
|
|
* @throws ValidationException
|
|
*/
|
|
public function testConnection(Request $request): JsonResponse
|
|
{
|
|
$this->authorize('owner only');
|
|
|
|
$this->validate($request, [
|
|
'ai_driver' => 'required|string',
|
|
'ai_api_key' => 'nullable|string',
|
|
'ai_base_url' => 'nullable|string|url',
|
|
]);
|
|
|
|
$apiKey = $request->input('ai_api_key');
|
|
if ($apiKey === '********' || $apiKey === null || $apiKey === '') {
|
|
$existing = $this->aiConfigurationService->getCompanyConfig($request->header('company'));
|
|
$apiKey = $existing['ai_api_key'] ?? '';
|
|
}
|
|
|
|
if ($apiKey === '') {
|
|
return response()->json(['error' => 'missing_api_key'], 422);
|
|
}
|
|
|
|
try {
|
|
$driver = AiDriverFactory::make(
|
|
$request->input('ai_driver'),
|
|
$apiKey,
|
|
['base_url' => $request->input('ai_base_url')],
|
|
);
|
|
|
|
$result = $driver->validateConnection();
|
|
} catch (AiException $e) {
|
|
return response()->json(['error' => $e->errorKey, 'message' => $e->getMessage()], 422);
|
|
}
|
|
|
|
return response()->json(['success' => true, 'details' => $result]);
|
|
}
|
|
|
|
/**
|
|
* @param array<string, mixed> $config
|
|
* @return array<string, mixed>
|
|
*/
|
|
private function maskApiKey(array $config): array
|
|
{
|
|
if (! empty($config['ai_api_key'])) {
|
|
$config['ai_api_key'] = '********';
|
|
}
|
|
|
|
return $config;
|
|
}
|
|
}
|