mirror of
https://github.com/InvoiceShelf/InvoiceShelf.git
synced 2026-07-16 22:05:20 +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.
63 lines
1.7 KiB
TypeScript
63 lines
1.7 KiB
TypeScript
import { client } from '../client'
|
|
import { API } from '../endpoints'
|
|
import type { User, UserSetting } from '@/scripts/types/domain/user'
|
|
import type { Company } from '@/scripts/types/domain/company'
|
|
import type { Currency } from '@/scripts/types/domain/currency'
|
|
import type { Ability } from '@/scripts/types/domain/role'
|
|
|
|
export interface MenuItem {
|
|
title: string
|
|
name: string
|
|
link: string
|
|
icon: string
|
|
group: string
|
|
group_label?: string
|
|
priority?: number
|
|
ability?: string
|
|
}
|
|
|
|
export interface BootstrapResponse {
|
|
current_user: User
|
|
current_user_settings: Record<string, string>
|
|
current_user_abilities: Ability[]
|
|
companies: Company[]
|
|
current_company: Company | null
|
|
current_company_settings: Record<string, string>
|
|
current_company_currency: Currency | null
|
|
main_menu: MenuItem[]
|
|
setting_menu: MenuItem[]
|
|
config: Record<string, unknown>
|
|
global_settings: Record<string, string>
|
|
modules: string[]
|
|
ai?: {
|
|
enabled: boolean
|
|
chat_enabled: boolean
|
|
text_generation_enabled: boolean
|
|
}
|
|
user_menu?: Array<{ title: string; link: string; icon: string; priority: number; name: string }>
|
|
admin_mode?: boolean
|
|
pending_invitations?: Array<{
|
|
token: string
|
|
company_name: string
|
|
invited_by: string
|
|
email: string
|
|
}>
|
|
}
|
|
|
|
export interface CurrentCompanyResponse {
|
|
data: Company
|
|
}
|
|
|
|
export const bootstrapService = {
|
|
async bootstrap(adminMode?: boolean): Promise<BootstrapResponse> {
|
|
const url = adminMode ? `${API.BOOTSTRAP}?admin_mode=1` : API.BOOTSTRAP
|
|
const { data } = await client.get(url)
|
|
return data
|
|
},
|
|
|
|
async getCurrentCompany(): Promise<CurrentCompanyResponse> {
|
|
const { data } = await client.get(API.CURRENT_COMPANY)
|
|
return data
|
|
},
|
|
}
|