mirror of
https://github.com/InvoiceShelf/InvoiceShelf.git
synced 2026-07-18 06:45:20 +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.
269 lines
6.7 KiB
TypeScript
269 lines
6.7 KiB
TypeScript
import type { RouteRecordRaw } from 'vue-router'
|
|
import { ABILITIES } from '@/scripts/config/abilities'
|
|
|
|
const settingsRoutes: RouteRecordRaw[] = [
|
|
// User account settings — standalone page with sidebar tabs (General, Profile Photo, Security)
|
|
{
|
|
path: 'account-settings',
|
|
component: () => import('./views/UserSettingsLayoutView.vue'),
|
|
meta: {
|
|
requiresAuth: true,
|
|
},
|
|
children: [
|
|
{
|
|
path: '',
|
|
name: 'settings.account',
|
|
redirect: { name: 'settings.account.general' },
|
|
},
|
|
{
|
|
path: 'general',
|
|
name: 'settings.account.general',
|
|
component: () => import('./views/UserGeneralView.vue'),
|
|
},
|
|
{
|
|
path: 'profile-photo',
|
|
name: 'settings.account.profile-photo',
|
|
component: () => import('./views/UserProfilePhotoView.vue'),
|
|
},
|
|
{
|
|
path: 'security',
|
|
name: 'settings.account.security',
|
|
component: () => import('./views/UserSecurityView.vue'),
|
|
},
|
|
],
|
|
},
|
|
{
|
|
path: 'settings',
|
|
component: () => import('./views/SettingsLayoutView.vue'),
|
|
children: [
|
|
{
|
|
path: 'roles-settings',
|
|
redirect: { name: 'settings.roles' },
|
|
},
|
|
{
|
|
path: 'exchange-rate-provider',
|
|
redirect: { name: 'settings.exchange-rate' },
|
|
},
|
|
{
|
|
path: 'payment-mode',
|
|
redirect: { name: 'settings.payment-modes' },
|
|
},
|
|
{
|
|
path: 'expense-category',
|
|
redirect: { name: 'settings.expense-categories' },
|
|
},
|
|
{
|
|
path: 'mail-configuration',
|
|
redirect: { name: 'settings.mail-config' },
|
|
},
|
|
{
|
|
path: 'modules-configuration',
|
|
redirect: { name: 'settings.modules' },
|
|
},
|
|
{
|
|
path: 'company-info',
|
|
name: 'settings.company-info',
|
|
meta: {
|
|
requiresAuth: true,
|
|
isOwner: true,
|
|
},
|
|
component: () => import('./views/CompanyInfoView.vue'),
|
|
},
|
|
{
|
|
path: 'preferences',
|
|
name: 'settings.preferences',
|
|
meta: {
|
|
requiresAuth: true,
|
|
isOwner: true,
|
|
},
|
|
component: () => import('./views/PreferencesView.vue'),
|
|
},
|
|
{
|
|
path: 'customization',
|
|
name: 'settings.customization',
|
|
meta: {
|
|
requiresAuth: true,
|
|
isOwner: true,
|
|
},
|
|
component: () => import('./views/CustomizationView.vue'),
|
|
},
|
|
{
|
|
path: 'tax-types',
|
|
name: 'settings.tax-types',
|
|
meta: {
|
|
requiresAuth: true,
|
|
ability: ABILITIES.VIEW_TAX_TYPE,
|
|
},
|
|
component: () => import('./views/TaxTypesView.vue'),
|
|
},
|
|
{
|
|
path: 'payment-modes',
|
|
name: 'settings.payment-modes',
|
|
meta: {
|
|
requiresAuth: true,
|
|
},
|
|
component: () => import('./views/PaymentModesView.vue'),
|
|
},
|
|
{
|
|
path: 'custom-fields',
|
|
name: 'settings.custom-fields',
|
|
meta: {
|
|
requiresAuth: true,
|
|
ability: ABILITIES.VIEW_CUSTOM_FIELDS,
|
|
},
|
|
component: () => import('./views/CustomFieldsView.vue'),
|
|
},
|
|
{
|
|
path: 'notes',
|
|
name: 'settings.notes',
|
|
meta: {
|
|
requiresAuth: true,
|
|
ability: ABILITIES.VIEW_NOTE,
|
|
},
|
|
component: () => import('./views/NotesView.vue'),
|
|
},
|
|
{
|
|
path: 'notifications',
|
|
name: 'settings.notifications',
|
|
meta: {
|
|
requiresAuth: true,
|
|
isOwner: true,
|
|
},
|
|
component: () => import('./views/NotificationsView.vue'),
|
|
},
|
|
{
|
|
path: 'expense-categories',
|
|
name: 'settings.expense-categories',
|
|
meta: {
|
|
requiresAuth: true,
|
|
ability: ABILITIES.VIEW_EXPENSE,
|
|
},
|
|
component: () => import('./views/ExpenseCategoriesView.vue'),
|
|
},
|
|
{
|
|
path: 'exchange-rate',
|
|
name: 'settings.exchange-rate',
|
|
meta: {
|
|
requiresAuth: true,
|
|
ability: ABILITIES.VIEW_EXCHANGE_RATE,
|
|
},
|
|
component: () => import('./views/ExchangeRateView.vue'),
|
|
},
|
|
{
|
|
path: 'mail-config',
|
|
name: 'settings.mail-config',
|
|
meta: {
|
|
requiresAuth: true,
|
|
isOwner: true,
|
|
},
|
|
component: () => import('./views/MailConfigView.vue'),
|
|
},
|
|
{
|
|
path: 'ai-config',
|
|
name: 'settings.ai-config',
|
|
meta: {
|
|
requiresAuth: true,
|
|
isOwner: true,
|
|
},
|
|
component: () => import('./views/AiConfigView.vue'),
|
|
},
|
|
{
|
|
path: 'roles',
|
|
name: 'settings.roles',
|
|
meta: {
|
|
requiresAuth: true,
|
|
isOwner: true,
|
|
},
|
|
component: () => import('./views/RolesView.vue'),
|
|
},
|
|
{
|
|
path: 'modules',
|
|
name: 'settings.modules',
|
|
meta: {
|
|
requiresAuth: true,
|
|
isOwner: true,
|
|
},
|
|
component: () => import('@/scripts/features/company/modules/views/CompanyModulesIndexView.vue'),
|
|
},
|
|
{
|
|
path: 'danger-zone',
|
|
name: 'settings.danger-zone',
|
|
meta: {
|
|
requiresAuth: true,
|
|
isOwner: true,
|
|
},
|
|
component: () => import('./views/DangerZoneView.vue'),
|
|
},
|
|
],
|
|
},
|
|
{
|
|
path: 'user-settings/:tab?',
|
|
redirect: { name: 'settings.account' },
|
|
},
|
|
{
|
|
path: 'settings/account-settings',
|
|
redirect: { name: 'settings.account' },
|
|
},
|
|
{
|
|
path: 'company-info',
|
|
redirect: { name: 'settings.company-info' },
|
|
},
|
|
{
|
|
path: 'preferences',
|
|
redirect: { name: 'settings.preferences' },
|
|
},
|
|
{
|
|
path: 'customization',
|
|
redirect: { name: 'settings.customization' },
|
|
},
|
|
{
|
|
path: 'notifications',
|
|
redirect: { name: 'settings.notifications' },
|
|
},
|
|
{
|
|
path: 'roles-settings',
|
|
redirect: { name: 'settings.roles' },
|
|
},
|
|
{
|
|
path: 'exchange-rate-provider',
|
|
redirect: { name: 'settings.exchange-rate' },
|
|
},
|
|
{
|
|
path: 'tax-types',
|
|
redirect: { name: 'settings.tax-types' },
|
|
},
|
|
{
|
|
path: 'payment-mode',
|
|
redirect: { name: 'settings.payment-modes' },
|
|
},
|
|
{
|
|
path: 'custom-fields',
|
|
redirect: { name: 'settings.custom-fields' },
|
|
},
|
|
{
|
|
path: 'notes',
|
|
redirect: { name: 'settings.notes' },
|
|
},
|
|
{
|
|
path: 'expense-category',
|
|
redirect: { name: 'settings.expense-categories' },
|
|
},
|
|
{
|
|
path: 'mail-configuration',
|
|
redirect: { name: 'settings.mail-config' },
|
|
},
|
|
// Legacy module routes — preserved so existing bookmarks (and the old in-app
|
|
// sidebar slot at /admin/modules) still resolve to the Module Configuration
|
|
// page, which now lives under Company Settings.
|
|
{
|
|
path: 'modules',
|
|
redirect: { name: 'settings.modules' },
|
|
},
|
|
{
|
|
path: 'modules/:slug/settings',
|
|
redirect: { name: 'settings.modules' },
|
|
},
|
|
]
|
|
|
|
export default settingsRoutes
|