mirror of
https://github.com/InvoiceShelf/InvoiceShelf.git
synced 2026-07-17 22:35:19 +00:00
feat(ai): Phase 1 — provider configuration, installer step, admin + company settings
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.
This commit is contained in:
@@ -8,6 +8,7 @@ use App\Http\Controllers\Admin\CurrenciesController;
|
||||
use App\Http\Controllers\Admin\FontController;
|
||||
use App\Http\Controllers\Admin\Modules\ModuleInstallationController;
|
||||
use App\Http\Controllers\Admin\Modules\ModulesController;
|
||||
use App\Http\Controllers\Admin\Settings\AiConfigurationController;
|
||||
use App\Http\Controllers\Admin\Settings\DiskController;
|
||||
use App\Http\Controllers\Admin\Settings\MailConfigurationController;
|
||||
use App\Http\Controllers\Admin\Settings\PDFConfigurationController;
|
||||
@@ -48,6 +49,7 @@ use App\Http\Controllers\Company\RecurringInvoice\RecurringInvoiceController;
|
||||
use App\Http\Controllers\Company\RecurringInvoice\RecurringInvoiceFrequencyController;
|
||||
use App\Http\Controllers\Company\Role\AbilitiesController;
|
||||
use App\Http\Controllers\Company\Role\RolesController;
|
||||
use App\Http\Controllers\Company\Settings\CompanyAiConfigurationController;
|
||||
use App\Http\Controllers\Company\Settings\CompanyController;
|
||||
use App\Http\Controllers\Company\Settings\CompanyMailConfigurationController;
|
||||
use App\Http\Controllers\Company\Settings\CompanySettingsController;
|
||||
@@ -65,6 +67,7 @@ use App\Http\Controllers\CustomerPortal\General\ProfileController as CustomerPro
|
||||
use App\Http\Controllers\CustomerPortal\Invoice\InvoicesController as CustomerInvoicesController;
|
||||
use App\Http\Controllers\CustomerPortal\Payment\PaymentMethodController;
|
||||
use App\Http\Controllers\CustomerPortal\Payment\PaymentsController as CustomerPaymentsController;
|
||||
use App\Http\Controllers\Setup\AiConfigurationController as InstallerAiConfigurationController;
|
||||
use App\Http\Controllers\Setup\AppDomainController;
|
||||
use App\Http\Controllers\Setup\DatabaseConfigurationController;
|
||||
use App\Http\Controllers\Setup\FilePermissionsController;
|
||||
@@ -153,6 +156,9 @@ Route::prefix('/v1')->group(function () {
|
||||
|
||||
Route::put('/set-domain', AppDomainController::class);
|
||||
|
||||
Route::get('/ai/config', [InstallerAiConfigurationController::class, 'show']);
|
||||
Route::post('/ai/config', [InstallerAiConfigurationController::class, 'save']);
|
||||
|
||||
Route::post('/login', LoginController::class);
|
||||
|
||||
Route::post('/finish', FinishController::class);
|
||||
@@ -415,6 +421,18 @@ Route::prefix('/v1')->group(function () {
|
||||
Route::post('/company/mail/company-config', [CompanyMailConfigurationController::class, 'saveMailConfig']);
|
||||
Route::post('/company/mail/company-test', [CompanyMailConfigurationController::class, 'testMailConfig']);
|
||||
|
||||
// AI Configuration
|
||||
// ----------------------------------
|
||||
|
||||
Route::get('/ai/drivers', [AiConfigurationController::class, 'getDrivers']);
|
||||
Route::get('/ai/config', [AiConfigurationController::class, 'getConfig']);
|
||||
Route::post('/ai/config', [AiConfigurationController::class, 'saveConfig']);
|
||||
Route::post('/ai/test', [AiConfigurationController::class, 'testConnection']);
|
||||
|
||||
Route::get('/company/ai/config', [CompanyAiConfigurationController::class, 'getConfig']);
|
||||
Route::post('/company/ai/config', [CompanyAiConfigurationController::class, 'saveConfig']);
|
||||
Route::post('/company/ai/test', [CompanyAiConfigurationController::class, 'testConnection']);
|
||||
|
||||
// PDF Generation
|
||||
// ----------------------------------
|
||||
|
||||
|
||||
Reference in New Issue
Block a user