mirror of
https://github.com/InvoiceShelf/InvoiceShelf.git
synced 2026-07-17 14:25:21 +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.
133 lines
3.9 KiB
TypeScript
133 lines
3.9 KiB
TypeScript
import type { RouteRecordRaw } from 'vue-router'
|
|
import InstallationLayout from '@/scripts/layouts/InstallationLayout.vue'
|
|
|
|
/**
|
|
* The installation wizard is a multi-step flow. Every step is a child of the
|
|
* /installation parent route, which renders InstallationLayout (logo, card
|
|
* chrome, step progress dots) once and a <router-view /> inside the card.
|
|
*
|
|
* Step order — Language is intentionally first so the rest of the wizard
|
|
* renders in the user's chosen locale:
|
|
*
|
|
* 1. LanguageView (/installation/language)
|
|
* 2. RequirementsView (/installation/requirements)
|
|
* 3. PermissionsView (/installation/permissions)
|
|
* 4. DatabaseView (/installation/database)
|
|
* 5. DomainView (/installation/domain)
|
|
* 6. MailView (/installation/mail)
|
|
* 7. AiView (/installation/ai) — optional, skippable
|
|
* 8. AccountView (/installation/account)
|
|
* 9. CompanyView (/installation/company)
|
|
* 10. PreferencesView (/installation/preferences)
|
|
*
|
|
* Each child view owns its own next() function and calls router.push() to
|
|
* the next step by route name. There is no event-based step coordination —
|
|
* the router IS the state machine.
|
|
*/
|
|
|
|
export const installationRoutes: RouteRecordRaw[] = [
|
|
{
|
|
path: '/installation',
|
|
component: InstallationLayout,
|
|
meta: {
|
|
isInstallation: true,
|
|
},
|
|
children: [
|
|
{
|
|
path: '',
|
|
redirect: { name: 'installation.language' },
|
|
},
|
|
{
|
|
path: 'language',
|
|
name: 'installation.language',
|
|
component: () => import('./views/LanguageView.vue'),
|
|
meta: {
|
|
title: 'wizard.install_language.title',
|
|
isInstallation: true,
|
|
},
|
|
},
|
|
{
|
|
path: 'requirements',
|
|
name: 'installation.requirements',
|
|
component: () => import('./views/RequirementsView.vue'),
|
|
meta: {
|
|
title: 'wizard.req.system_req',
|
|
isInstallation: true,
|
|
},
|
|
},
|
|
{
|
|
path: 'permissions',
|
|
name: 'installation.permissions',
|
|
component: () => import('./views/PermissionsView.vue'),
|
|
meta: {
|
|
title: 'wizard.permissions.permissions',
|
|
isInstallation: true,
|
|
},
|
|
},
|
|
{
|
|
path: 'database',
|
|
name: 'installation.database',
|
|
component: () => import('./views/DatabaseView.vue'),
|
|
meta: {
|
|
title: 'wizard.database.database',
|
|
isInstallation: true,
|
|
},
|
|
},
|
|
{
|
|
path: 'domain',
|
|
name: 'installation.domain',
|
|
component: () => import('./views/DomainView.vue'),
|
|
meta: {
|
|
title: 'wizard.verify_domain.title',
|
|
isInstallation: true,
|
|
},
|
|
},
|
|
{
|
|
path: 'mail',
|
|
name: 'installation.mail',
|
|
component: () => import('./views/MailView.vue'),
|
|
meta: {
|
|
title: 'wizard.mail.mail_config',
|
|
isInstallation: true,
|
|
},
|
|
},
|
|
{
|
|
path: 'ai',
|
|
name: 'installation.ai',
|
|
component: () => import('./views/AiView.vue'),
|
|
meta: {
|
|
title: 'settings.ai.installer_title',
|
|
isInstallation: true,
|
|
},
|
|
},
|
|
{
|
|
path: 'account',
|
|
name: 'installation.account',
|
|
component: () => import('./views/AccountView.vue'),
|
|
meta: {
|
|
title: 'wizard.account_info',
|
|
isInstallation: true,
|
|
},
|
|
},
|
|
{
|
|
path: 'company',
|
|
name: 'installation.company',
|
|
component: () => import('./views/CompanyView.vue'),
|
|
meta: {
|
|
title: 'wizard.company_info',
|
|
isInstallation: true,
|
|
},
|
|
},
|
|
{
|
|
path: 'preferences',
|
|
name: 'installation.preferences',
|
|
component: () => import('./views/PreferencesView.vue'),
|
|
meta: {
|
|
title: 'wizard.preferences',
|
|
isInstallation: true,
|
|
},
|
|
},
|
|
],
|
|
},
|
|
]
|