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.
152 lines
4.3 KiB
TypeScript
152 lines
4.3 KiB
TypeScript
import type { RouteRecordRaw } from 'vue-router'
|
|
import { adminModuleRoutes } from './modules/routes'
|
|
|
|
const CompanyLayout = () => import('../../layouts/CompanyLayout.vue')
|
|
const AdminDashboardView = () => import('./views/AdminDashboardView.vue')
|
|
const AdminCompaniesView = () => import('./views/AdminCompaniesView.vue')
|
|
const AdminCompanyEditView = () => import('./views/AdminCompanyEditView.vue')
|
|
const AdminUsersView = () => import('./views/AdminUsersView.vue')
|
|
const AdminUserEditView = () => import('./views/AdminUserEditView.vue')
|
|
const AdminSettingsView = () => import('./views/AdminSettingsView.vue')
|
|
const AdminMailConfigView = () => import('./views/settings/AdminMailConfigView.vue')
|
|
const AdminAiConfigView = () => import('./views/settings/AdminAiConfigView.vue')
|
|
const AdminPdfGenerationView = () => import('./views/settings/AdminPdfGenerationView.vue')
|
|
const AdminBackupView = () => import('./views/settings/AdminBackupView.vue')
|
|
const AdminFileDiskView = () => import('./views/settings/AdminFileDiskView.vue')
|
|
const AdminFontView = () => import('./views/settings/AdminFontView.vue')
|
|
const AdminUpdateAppView = () => import('./views/settings/AdminUpdateAppView.vue')
|
|
const AdminAppearanceView = () => import('./views/settings/AdminAppearanceView.vue')
|
|
|
|
export const adminRoutes: RouteRecordRaw[] = [
|
|
{
|
|
path: '/admin/administration',
|
|
component: CompanyLayout,
|
|
meta: {
|
|
requiresAuth: true,
|
|
isSuperAdmin: true,
|
|
usesAdminBootstrap: true,
|
|
},
|
|
children: [
|
|
{
|
|
path: 'dashboard',
|
|
name: 'admin.dashboard',
|
|
component: AdminDashboardView,
|
|
meta: {
|
|
isSuperAdmin: true,
|
|
},
|
|
},
|
|
{
|
|
path: 'companies',
|
|
name: 'admin.companies.index',
|
|
component: AdminCompaniesView,
|
|
meta: {
|
|
isSuperAdmin: true,
|
|
},
|
|
},
|
|
{
|
|
path: 'companies/:id/edit',
|
|
name: 'admin.companies.edit',
|
|
component: AdminCompanyEditView,
|
|
meta: {
|
|
isSuperAdmin: true,
|
|
},
|
|
},
|
|
{
|
|
path: 'users',
|
|
name: 'admin.users.index',
|
|
component: AdminUsersView,
|
|
meta: {
|
|
isSuperAdmin: true,
|
|
},
|
|
},
|
|
{
|
|
path: 'users/:id/edit',
|
|
name: 'admin.users.edit',
|
|
component: AdminUserEditView,
|
|
meta: {
|
|
isSuperAdmin: true,
|
|
},
|
|
},
|
|
...adminModuleRoutes,
|
|
{
|
|
path: 'settings',
|
|
name: 'admin.settings',
|
|
component: AdminSettingsView,
|
|
meta: {
|
|
isSuperAdmin: true,
|
|
},
|
|
children: [
|
|
{
|
|
path: '',
|
|
redirect: 'mail-configuration',
|
|
},
|
|
{
|
|
path: 'mail-configuration',
|
|
name: 'admin.settings.mail',
|
|
meta: {
|
|
isSuperAdmin: true,
|
|
},
|
|
component: AdminMailConfigView,
|
|
},
|
|
{
|
|
path: 'ai-configuration',
|
|
name: 'admin.settings.ai',
|
|
meta: {
|
|
isSuperAdmin: true,
|
|
},
|
|
component: AdminAiConfigView,
|
|
},
|
|
{
|
|
path: 'pdf-generation',
|
|
name: 'admin.settings.pdf',
|
|
meta: {
|
|
isSuperAdmin: true,
|
|
},
|
|
component: AdminPdfGenerationView,
|
|
},
|
|
{
|
|
path: 'backup',
|
|
name: 'admin.settings.backup',
|
|
meta: {
|
|
isSuperAdmin: true,
|
|
},
|
|
component: AdminBackupView,
|
|
},
|
|
{
|
|
path: 'file-disk',
|
|
name: 'admin.settings.disk',
|
|
meta: {
|
|
isSuperAdmin: true,
|
|
},
|
|
component: AdminFileDiskView,
|
|
},
|
|
{
|
|
path: 'fonts',
|
|
name: 'admin.settings.fonts',
|
|
meta: {
|
|
isSuperAdmin: true,
|
|
},
|
|
component: AdminFontView,
|
|
},
|
|
{
|
|
path: 'update-app',
|
|
name: 'admin.settings.update',
|
|
meta: {
|
|
isSuperAdmin: true,
|
|
},
|
|
component: AdminUpdateAppView,
|
|
},
|
|
{
|
|
path: 'appearance',
|
|
name: 'admin.settings.appearance',
|
|
meta: {
|
|
isSuperAdmin: true,
|
|
},
|
|
component: AdminAppearanceView,
|
|
},
|
|
],
|
|
},
|
|
],
|
|
},
|
|
]
|