mirror of
https://github.com/InvoiceShelf/InvoiceShelf.git
synced 2026-07-17 14:25:21 +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.
165 lines
6.4 KiB
PHP
165 lines
6.4 KiB
PHP
<?php
|
|
|
|
namespace App\Http\Controllers\Company\General;
|
|
|
|
use App\Http\Controllers\Controller;
|
|
use App\Http\Resources\CompanyInvitationResource;
|
|
use App\Http\Resources\CompanyResource;
|
|
use App\Http\Resources\UserResource;
|
|
use App\Models\Company;
|
|
use App\Models\CompanyInvitation;
|
|
use App\Models\CompanySetting;
|
|
use App\Models\Currency;
|
|
use App\Models\Module;
|
|
use App\Models\Setting;
|
|
use App\Services\AiConfigurationService;
|
|
use App\Traits\GeneratesMenuTrait;
|
|
use Illuminate\Http\JsonResponse;
|
|
use Illuminate\Http\Request;
|
|
use InvoiceShelf\Modules\Registry as ModuleRegistry;
|
|
use Silber\Bouncer\BouncerFacade;
|
|
|
|
class BootstrapController extends Controller
|
|
{
|
|
use GeneratesMenuTrait;
|
|
|
|
/**
|
|
* Handle the incoming request.
|
|
*
|
|
* @return JsonResponse
|
|
*/
|
|
public function __invoke(Request $request)
|
|
{
|
|
$current_user = $request->user();
|
|
$current_user_settings = $current_user->getAllSettings();
|
|
$companies = $current_user->companies;
|
|
|
|
$pendingInvitations = CompanyInvitation::forUser($current_user)
|
|
->pending()
|
|
->with(['company', 'role', 'invitedBy'])
|
|
->get();
|
|
|
|
$global_settings = Setting::getSettings([
|
|
'api_token',
|
|
'admin_portal_theme',
|
|
'admin_portal_logo',
|
|
'login_page_logo',
|
|
'login_page_heading',
|
|
'login_page_description',
|
|
'admin_page_title',
|
|
'copyright_text',
|
|
'save_pdf_to_disk',
|
|
'show_sidebar_group_labels',
|
|
]);
|
|
|
|
// Super admin mode — return admin-only menu with all companies listed
|
|
if ($current_user->isSuperAdmin() && $request->has('admin_mode')) {
|
|
return response()->json([
|
|
'current_user' => new UserResource($current_user),
|
|
'current_user_settings' => $current_user_settings,
|
|
'current_user_abilities' => [],
|
|
'companies' => CompanyResource::collection($companies),
|
|
'current_company' => null,
|
|
'current_company_settings' => [],
|
|
'current_company_currency' => Currency::first(),
|
|
'config' => config('invoiceshelf'),
|
|
'global_settings' => $global_settings,
|
|
'main_menu' => $this->generateMenu('admin_menu', $current_user),
|
|
'setting_menu' => [],
|
|
'modules' => [],
|
|
'admin_mode' => true,
|
|
'pending_invitations' => CompanyInvitationResource::collection($pendingInvitations),
|
|
]);
|
|
}
|
|
|
|
// User has no companies — return minimal bootstrap
|
|
if ($companies->isEmpty()) {
|
|
return response()->json([
|
|
'current_user' => new UserResource($current_user),
|
|
'current_user_settings' => $current_user_settings,
|
|
'current_user_abilities' => [],
|
|
'companies' => [],
|
|
'current_company' => null,
|
|
'current_company_settings' => [],
|
|
'current_company_currency' => Currency::first(),
|
|
'config' => config('invoiceshelf'),
|
|
'global_settings' => $global_settings,
|
|
'main_menu' => [],
|
|
'setting_menu' => [],
|
|
'modules' => [],
|
|
'pending_invitations' => CompanyInvitationResource::collection($pendingInvitations),
|
|
]);
|
|
}
|
|
|
|
$main_menu = $this->generateMenu('main_menu', $current_user);
|
|
$setting_menu = $this->generateMenu('setting_menu', $current_user);
|
|
|
|
// Merge module-registered menu items into the main menu so they
|
|
// participate in the unified group + priority ordering.
|
|
foreach (ModuleRegistry::allMenu() as $slug => $item) {
|
|
$main_menu[] = [
|
|
'title' => __($item['title']),
|
|
'link' => $item['link'],
|
|
'icon' => $item['icon'],
|
|
'name' => 'module-'.$slug,
|
|
'group' => $item['group'] ?? 'modules',
|
|
'group_label' => $item['group_label'] ?? 'navigation.modules',
|
|
'priority' => $item['priority'] ?? 100,
|
|
];
|
|
}
|
|
|
|
$current_company = Company::find($request->header('company'));
|
|
|
|
if ((! $current_company) || ($current_company && ! $current_user->hasCompany($current_company->id))) {
|
|
$current_company = $current_user->companies()->first();
|
|
}
|
|
|
|
$current_company_settings = CompanySetting::getAllSettings($current_company->id);
|
|
|
|
$current_company_currency = $current_company_settings->has('currency')
|
|
? Currency::find($current_company_settings->get('currency'))
|
|
: Currency::first();
|
|
|
|
BouncerFacade::refreshFor($current_user);
|
|
|
|
$aiResolved = app(AiConfigurationService::class)->resolveForCompany($current_company->id);
|
|
|
|
return response()->json([
|
|
'current_user' => new UserResource($current_user),
|
|
'current_user_settings' => $current_user_settings,
|
|
'current_user_abilities' => $current_user->getAbilities(),
|
|
'companies' => CompanyResource::collection($companies),
|
|
'current_company' => new CompanyResource($current_company),
|
|
'current_company_settings' => $current_company_settings,
|
|
'current_company_currency' => $current_company_currency,
|
|
'config' => config('invoiceshelf'),
|
|
'global_settings' => $global_settings,
|
|
'ai' => [
|
|
'enabled' => $aiResolved !== null,
|
|
'chat_enabled' => (bool) ($aiResolved['chat_enabled'] ?? false),
|
|
'text_generation_enabled' => (bool) ($aiResolved['text_generation_enabled'] ?? false),
|
|
],
|
|
'main_menu' => $main_menu,
|
|
'setting_menu' => $setting_menu,
|
|
'modules' => Module::where('enabled', true)->pluck('name'),
|
|
'user_menu' => collect(ModuleRegistry::allUserMenu())
|
|
->map(fn (array $item, string $slug) => [
|
|
...$item,
|
|
'title' => __($item['title']),
|
|
'name' => 'module-'.$slug,
|
|
])
|
|
->sortBy('priority')
|
|
->values()
|
|
->all(),
|
|
'pending_invitations' => CompanyInvitationResource::collection($pendingInvitations),
|
|
]);
|
|
}
|
|
|
|
public function currentCompany(Request $request)
|
|
{
|
|
$company = Company::find($request->header('company'));
|
|
|
|
return new CompanyResource($company);
|
|
}
|
|
}
|