mirror of
https://github.com/InvoiceShelf/InvoiceShelf.git
synced 2026-07-17 06:15: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.
133 lines
3.4 KiB
Vue
133 lines
3.4 KiB
Vue
<template>
|
|
<BasePage>
|
|
<BasePageHeader :title="$t('administration.settings.title')" class="mb-6">
|
|
<BaseBreadcrumb>
|
|
<BaseBreadcrumbItem :title="$t('general.home')" to="/admin/dashboard" />
|
|
<BaseBreadcrumbItem
|
|
:title="$t('administration.settings.title')"
|
|
to="#"
|
|
active
|
|
/>
|
|
</BaseBreadcrumb>
|
|
</BasePageHeader>
|
|
|
|
<div class="w-full mb-6 select-wrapper xl:hidden">
|
|
<BaseMultiselect
|
|
v-model="currentSetting"
|
|
:options="menuItems"
|
|
:can-deselect="false"
|
|
value-prop="title"
|
|
track-by="title"
|
|
label="title"
|
|
object
|
|
@update:model-value="navigateToSetting"
|
|
/>
|
|
</div>
|
|
|
|
<div class="flex gap-8">
|
|
<div class="hidden mt-1 xl:block min-w-[240px] sticky top-20 self-start">
|
|
<BaseList>
|
|
<BaseListItem
|
|
v-for="(menuItem, index) in menuItems"
|
|
:key="index"
|
|
:title="menuItem.title"
|
|
:to="menuItem.link"
|
|
:active="hasActiveUrl(menuItem.link)"
|
|
:index="index"
|
|
class="py-3"
|
|
>
|
|
<template #icon>
|
|
<BaseIcon :name="menuItem.icon" />
|
|
</template>
|
|
</BaseListItem>
|
|
</BaseList>
|
|
</div>
|
|
|
|
<div class="w-full overflow-visible">
|
|
<RouterView />
|
|
</div>
|
|
</div>
|
|
</BasePage>
|
|
</template>
|
|
|
|
<script setup lang="ts">
|
|
import { ref, computed, watchEffect } from 'vue'
|
|
import { useRoute, useRouter, RouterView } from 'vue-router'
|
|
import { useI18n } from 'vue-i18n'
|
|
|
|
interface SettingsMenuItem {
|
|
title: string
|
|
link: string
|
|
icon: string
|
|
}
|
|
|
|
const { t } = useI18n()
|
|
const route = useRoute()
|
|
const router = useRouter()
|
|
|
|
const currentSetting = ref<SettingsMenuItem | undefined>(undefined)
|
|
|
|
const menuItems = computed<SettingsMenuItem[]>(() => [
|
|
{
|
|
title: t('settings.mail.mail_config'),
|
|
link: '/admin/administration/settings/mail-configuration',
|
|
icon: 'EnvelopeIcon',
|
|
},
|
|
{
|
|
title: t('settings.menu_title.ai_configuration'),
|
|
link: '/admin/administration/settings/ai-configuration',
|
|
icon: 'SparklesIcon',
|
|
},
|
|
{
|
|
title: t('settings.menu_title.pdf_generation'),
|
|
link: '/admin/administration/settings/pdf-generation',
|
|
icon: 'DocumentIcon',
|
|
},
|
|
{
|
|
title: t('settings.menu_title.backup'),
|
|
link: '/admin/administration/settings/backup',
|
|
icon: 'CircleStackIcon',
|
|
},
|
|
{
|
|
title: t('settings.menu_title.file_disk'),
|
|
link: '/admin/administration/settings/file-disk',
|
|
icon: 'FolderIcon',
|
|
},
|
|
{
|
|
title: t('settings.menu_title.fonts'),
|
|
link: '/admin/administration/settings/fonts',
|
|
icon: 'LanguageIcon',
|
|
},
|
|
{
|
|
title: t('settings.menu_title.update_app'),
|
|
link: '/admin/administration/settings/update-app',
|
|
icon: 'ArrowPathIcon',
|
|
},
|
|
{
|
|
title: t('settings.menu_title.appearance'),
|
|
link: '/admin/administration/settings/appearance',
|
|
icon: 'PaintBrushIcon',
|
|
},
|
|
])
|
|
|
|
watchEffect(() => {
|
|
if (route.path === '/admin/administration/settings') {
|
|
router.push('/admin/administration/settings/mail-configuration')
|
|
}
|
|
|
|
const item = menuItems.value.find((item) => {
|
|
return route.path.indexOf(item.link) > -1
|
|
})
|
|
|
|
currentSetting.value = item
|
|
})
|
|
|
|
function hasActiveUrl(url: string): boolean {
|
|
return route.path.indexOf(url) > -1
|
|
}
|
|
|
|
function navigateToSetting(setting: SettingsMenuItem): void {
|
|
router.push(setting.link)
|
|
}
|
|
</script>
|