mirror of
https://github.com/InvoiceShelf/InvoiceShelf.git
synced 2026-07-16 22:05:20 +00:00
c7fab5d52f
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.
95 lines
3.8 KiB
PHP
95 lines
3.8 KiB
PHP
<?php
|
|
|
|
namespace App\Providers;
|
|
|
|
use App\Support\Ai\OpenRouterDriver;
|
|
use App\Support\ExchangeRate\CurrencyConverterDriver;
|
|
use App\Support\ExchangeRate\CurrencyFreakDriver;
|
|
use App\Support\ExchangeRate\CurrencyLayerDriver;
|
|
use App\Support\ExchangeRate\OpenExchangeRateDriver;
|
|
use Illuminate\Support\ServiceProvider;
|
|
use InvoiceShelf\Modules\Registry;
|
|
|
|
class DriverRegistryProvider extends ServiceProvider
|
|
{
|
|
public function boot(): void
|
|
{
|
|
$this->registerExchangeRateDrivers();
|
|
$this->registerAiDrivers();
|
|
}
|
|
|
|
protected function registerExchangeRateDrivers(): void
|
|
{
|
|
Registry::registerExchangeRateDriver('currency_converter', [
|
|
'class' => CurrencyConverterDriver::class,
|
|
'label' => 'settings.exchange_rate.currency_converter',
|
|
'website' => 'https://www.currencyconverterapi.com',
|
|
'config_fields' => [
|
|
[
|
|
'key' => 'type',
|
|
'type' => 'select',
|
|
'label' => 'settings.exchange_rate.server',
|
|
'options' => [
|
|
['label' => 'settings.preferences.premium', 'value' => 'PREMIUM'],
|
|
['label' => 'settings.preferences.prepaid', 'value' => 'PREPAID'],
|
|
['label' => 'settings.preferences.free', 'value' => 'FREE'],
|
|
['label' => 'settings.preferences.dedicated', 'value' => 'DEDICATED'],
|
|
],
|
|
'default' => 'FREE',
|
|
],
|
|
[
|
|
'key' => 'url',
|
|
'type' => 'text',
|
|
'label' => 'settings.exchange_rate.url',
|
|
'visible_when' => ['type' => 'DEDICATED'],
|
|
],
|
|
],
|
|
]);
|
|
|
|
Registry::registerExchangeRateDriver('currency_freak', [
|
|
'class' => CurrencyFreakDriver::class,
|
|
'label' => 'settings.exchange_rate.currency_freak',
|
|
'website' => 'https://currencyfreaks.com',
|
|
]);
|
|
|
|
Registry::registerExchangeRateDriver('currency_layer', [
|
|
'class' => CurrencyLayerDriver::class,
|
|
'label' => 'settings.exchange_rate.currency_layer',
|
|
'website' => 'https://currencylayer.com',
|
|
]);
|
|
|
|
Registry::registerExchangeRateDriver('open_exchange_rate', [
|
|
'class' => OpenExchangeRateDriver::class,
|
|
'label' => 'settings.exchange_rate.open_exchange_rate',
|
|
'website' => 'https://openexchangerates.org',
|
|
]);
|
|
}
|
|
|
|
protected function registerAiDrivers(): void
|
|
{
|
|
Registry::registerAiDriver('openrouter', [
|
|
'class' => OpenRouterDriver::class,
|
|
'label' => 'settings.ai.openrouter',
|
|
'website' => 'https://openrouter.ai',
|
|
'default_base_url' => 'https://openrouter.ai/api/v1',
|
|
'supported_roles' => ['chat', 'text_generation'],
|
|
'suggested_models' => [
|
|
['value' => 'openai/gpt-4o', 'label' => 'OpenAI GPT-4o'],
|
|
['value' => 'openai/gpt-4o-mini', 'label' => 'OpenAI GPT-4o mini'],
|
|
['value' => 'anthropic/claude-3.5-sonnet', 'label' => 'Anthropic Claude 3.5 Sonnet'],
|
|
['value' => 'anthropic/claude-3.5-haiku', 'label' => 'Anthropic Claude 3.5 Haiku'],
|
|
['value' => 'google/gemini-pro-1.5', 'label' => 'Google Gemini Pro 1.5'],
|
|
['value' => 'meta-llama/llama-3.3-70b-instruct', 'label' => 'Meta Llama 3.3 70B'],
|
|
],
|
|
'config_fields' => [
|
|
[
|
|
'key' => 'base_url',
|
|
'type' => 'text',
|
|
'label' => 'settings.ai.base_url',
|
|
'default' => 'https://openrouter.ai/api/v1',
|
|
],
|
|
],
|
|
]);
|
|
}
|
|
}
|