mirror of
https://github.com/InvoiceShelf/InvoiceShelf.git
synced 2026-07-16 22:05:20 +00:00
Second phase of the AI feature. Users can now open a slide-in chat drawer from the SiteHeader and ask natural-language questions about their company's invoices, customers, payments, and expenses. The LLM invokes pre-defined read-only tool functions (scoped to the current company at execute time) to fetch data and synthesize answers.
**Database** — new ai_conversations and ai_messages tables. Messages are stored in OpenAI's chat format so AiAssistantService serializes a conversation into an API request with zero translation. Columns: role, content, tool_call_id, tool_calls JSON, model, tokens_in, tokens_out. Conversations are scoped (company_id, user_id) — one user's chats are invisible to everyone else, even inside the same company. Foreign-key cascade deletes.
**Tool infrastructure** — AiTool abstract base + AiToolRegistry singleton (registered in a new AiServiceProvider). The base class enforces the security rule: every tool's execute() receives companyId and userId as injected parameters; tools' JSON schemas NEVER include a company_id field. An LLM physically cannot pass a company_id and escape tenancy. Modules can register their own tools by resolving the registry from their own ServiceProvider::boot().
**Nine built-in tools**: search_invoices, get_invoice, search_customers, get_customer, list_recent_payments, list_overdue_invoices, get_company_stats (aggregates for named periods), search_items, list_expense_categories. All read-only; no mutations. Each returns JSON-encodable data the LLM can parse.
**AiAssistantService orchestration loop** — the heart of Phase 2. Flow: persist user message → build payload from system prompt + recent history (40-message window) + new user message → call driver.chatCompletion with tools → if tool_calls, execute each one via the registry (with injected scope), persist tool result, loop → if plain text, persist and return. Hard cap at 5 iterations to prevent runaway LLMs. System prompt pins the assistant to this company's data and forbids mutation.
**Controllers + policy + rate limit** — POST /api/v1/ai/chat runs the orchestration loop. GET/PATCH/DELETE /api/v1/ai/conversations for CRUD. AiConversationPolicy enforces user_id+company_id match on every action. A new 'ai' RateLimiter in RouteServiceProvider throttles to 30 req/min per (user, company). New 'use ai' Gate defined in AppServiceProvider returns true for any authenticated user — the per-company kill-switch still goes through AiConfigurationService::resolveForCompany.
**Frontend** — new features/company/ai/ folder with a Pinia store (ai-chat.store.ts) holding drawer state, current conversation, messages, and loading flags. AiChatDrawer.vue is a slide-in panel teleported to <body>, mounted globally in CompanyLayout.vue when bootstrap reports ai.enabled && ai.chat_enabled. Sub-components: AiChatMessage (user bubbles vs assistant bubbles), AiChatMessageInput (Enter submits, Shift+Enter newline), AiChatConversationList (sidebar with 'new chat' button, rename, delete). A SparklesIcon button in SiteHeader toggles the drawer.
**Driver test double** — tests use a ScriptedAiDriver registered via AiDriverFactory::register('scripted', ...) that returns pre-queued AiChatResponse objects. Feature tests cover: happy path (new conversation + message persistence), tool-call loop (multi-round-trip with search_invoices), runaway-loop cap, driver-throws path, ai_enabled=NO rejection, chat role disabled rejection, per-user conversation visibility, cross-user policy enforcement, cascade delete.
388 tests pass (was 372, +16 new). Pint clean. npm run build clean. Phase 3 (WYSIWYG text generation popup) is the remaining follow-up.
328 lines
9.6 KiB
TypeScript
328 lines
9.6 KiB
TypeScript
import { defineStore } from 'pinia'
|
|
import { ref, computed } from 'vue'
|
|
import groupBy from 'lodash/groupBy'
|
|
import { bootstrapService } from '@/scripts/api/services/bootstrap.service'
|
|
import type { MenuItem, BootstrapResponse } from '@/scripts/api/services/bootstrap.service'
|
|
import { settingService } from '@/scripts/api/services/setting.service'
|
|
import type {
|
|
DateFormat,
|
|
TimeFormat,
|
|
ConfigResponse,
|
|
GlobalSettingsPayload,
|
|
NumberPlaceholdersParams,
|
|
NumberPlaceholder,
|
|
} from '@/scripts/api/services/setting.service'
|
|
import { useCompanyStore } from './company.store'
|
|
import { useUserStore } from './user.store'
|
|
import { useNotificationStore } from './notification.store'
|
|
import { handleApiError } from '../utils/error-handling'
|
|
import * as localStore from '../utils/local-storage'
|
|
import type { Currency } from '@/scripts/types/domain/currency'
|
|
import type { Country } from '@/scripts/types/domain/customer'
|
|
|
|
export const useGlobalStore = defineStore('global', () => {
|
|
// State
|
|
const config = ref<Record<string, unknown> | null>(null)
|
|
const globalSettings = ref<Record<string, string> | null>(null)
|
|
|
|
const timeZones = ref<Array<{ key: string; value: string }>>([])
|
|
const dateFormats = ref<DateFormat[]>([])
|
|
const timeFormats = ref<TimeFormat[]>([])
|
|
const currencies = ref<Currency[]>([])
|
|
const countries = ref<Country[]>([])
|
|
const languages = ref<Array<{ code: string; name: string }>>([])
|
|
const fiscalYears = ref<Array<{ key: string; value: string }>>([])
|
|
|
|
const mainMenu = ref<MenuItem[]>([])
|
|
const settingMenu = ref<MenuItem[]>([])
|
|
const userMenu = ref<Array<{ title: string; link: string; icon: string; name: string }>>([])
|
|
const ai = ref<{ enabled: boolean; chat_enabled: boolean; text_generation_enabled: boolean }>({
|
|
enabled: false,
|
|
chat_enabled: false,
|
|
text_generation_enabled: false,
|
|
})
|
|
const isAppLoaded = ref<boolean>(false)
|
|
const isSidebarOpen = ref<boolean>(false)
|
|
const isSidebarCollapsed = ref<boolean>(localStore.getBoolean('sidebarCollapsed'))
|
|
const areCurrenciesLoading = ref<boolean>(false)
|
|
|
|
const downloadReport = ref<(() => void) | null>(null)
|
|
|
|
// Getters
|
|
const menuGroups = computed<MenuItem[][]>(() => {
|
|
const sorted = [...mainMenu.value].sort((a, b) => (a.priority ?? 100) - (b.priority ?? 100))
|
|
const groups = groupBy(sorted, 'group')
|
|
return Object.values(groups).sort(
|
|
(a, b) => (a[0]?.priority ?? 100) - (b[0]?.priority ?? 100)
|
|
)
|
|
})
|
|
|
|
// Actions
|
|
async function bootstrap(options?: { adminMode?: boolean }): Promise<BootstrapResponse> {
|
|
const companyStore = useCompanyStore()
|
|
const userStore = useUserStore()
|
|
|
|
try {
|
|
const shouldUseAdminBootstrap = options?.adminMode ?? companyStore.isAdminMode
|
|
const response = await bootstrapService.bootstrap(shouldUseAdminBootstrap)
|
|
|
|
mainMenu.value = response.main_menu
|
|
settingMenu.value = response.setting_menu
|
|
userMenu.value = response.user_menu ?? []
|
|
ai.value = response.ai ?? {
|
|
enabled: false,
|
|
chat_enabled: false,
|
|
text_generation_enabled: false,
|
|
}
|
|
|
|
config.value = response.config
|
|
globalSettings.value = response.global_settings
|
|
|
|
// user store
|
|
userStore.currentUser = response.current_user
|
|
userStore.currentUserSettings = response.current_user_settings
|
|
userStore.currentAbilities = response.current_user_abilities
|
|
|
|
// Sync user form with bootstrap data
|
|
if (response.current_user) {
|
|
userStore.userForm = {
|
|
name: response.current_user.name ?? '',
|
|
email: response.current_user.email ?? '',
|
|
password: '',
|
|
confirm_password: '',
|
|
language: response.current_user_settings?.language ?? '',
|
|
}
|
|
}
|
|
|
|
// company store
|
|
companyStore.companies = response.companies
|
|
|
|
if (response.admin_mode === true) {
|
|
companyStore.setAdminMode(true)
|
|
companyStore.setSelectedCompany(null)
|
|
companyStore.selectedCompanySettings = {}
|
|
companyStore.selectedCompanyCurrency = null
|
|
} else if (response.current_company) {
|
|
companyStore.setAdminMode(false)
|
|
companyStore.setSelectedCompany(response.current_company)
|
|
companyStore.selectedCompanySettings = response.current_company_settings
|
|
companyStore.selectedCompanyCurrency = response.current_company_currency
|
|
} else {
|
|
companyStore.setAdminMode(false)
|
|
companyStore.setSelectedCompany(null)
|
|
companyStore.selectedCompanySettings = {}
|
|
companyStore.selectedCompanyCurrency = null
|
|
}
|
|
|
|
isAppLoaded.value = true
|
|
|
|
// Load UI language: user preference > company setting > English
|
|
// 'default' means "use company language"
|
|
const userLang = userStore.currentUserSettings.language
|
|
const uiLanguage =
|
|
(userLang && userLang !== 'default' ? userLang : '') ||
|
|
(response.current_company_settings as Record<string, string>)?.language ||
|
|
'en'
|
|
await (window as Record<string, unknown>).loadLanguage?.(uiLanguage)
|
|
|
|
return response
|
|
} catch (err: unknown) {
|
|
handleApiError(err)
|
|
throw err
|
|
}
|
|
}
|
|
|
|
async function fetchCurrencies(): Promise<Currency[]> {
|
|
if (currencies.value.length || areCurrenciesLoading.value) {
|
|
return currencies.value
|
|
}
|
|
|
|
areCurrenciesLoading.value = true
|
|
|
|
try {
|
|
const response = await settingService.getCurrencies()
|
|
currencies.value = response.data.map((currency) => ({
|
|
...currency,
|
|
name: `${currency.code} - ${currency.name}`,
|
|
}))
|
|
areCurrenciesLoading.value = false
|
|
return currencies.value
|
|
} catch (err: unknown) {
|
|
areCurrenciesLoading.value = false
|
|
handleApiError(err)
|
|
throw err
|
|
}
|
|
}
|
|
|
|
async function fetchConfig(params?: Record<string, string>): Promise<ConfigResponse> {
|
|
try {
|
|
const response = await settingService.getConfig(params)
|
|
|
|
if ((response as Record<string, unknown>).languages) {
|
|
languages.value = (response as Record<string, unknown>).languages as Array<{
|
|
code: string
|
|
name: string
|
|
}>
|
|
} else if ((response as Record<string, unknown>).fiscal_years) {
|
|
fiscalYears.value = (response as Record<string, unknown>).fiscal_years as Array<{
|
|
key: string
|
|
value: string
|
|
}>
|
|
}
|
|
|
|
return response
|
|
} catch (err: unknown) {
|
|
handleApiError(err)
|
|
throw err
|
|
}
|
|
}
|
|
|
|
async function fetchDateFormats(): Promise<DateFormat[]> {
|
|
if (dateFormats.value.length) {
|
|
return dateFormats.value
|
|
}
|
|
|
|
try {
|
|
const response = await settingService.getDateFormats()
|
|
dateFormats.value = response.date_formats
|
|
return dateFormats.value
|
|
} catch (err: unknown) {
|
|
handleApiError(err)
|
|
throw err
|
|
}
|
|
}
|
|
|
|
async function fetchTimeFormats(): Promise<TimeFormat[]> {
|
|
if (timeFormats.value.length) {
|
|
return timeFormats.value
|
|
}
|
|
|
|
try {
|
|
const response = await settingService.getTimeFormats()
|
|
timeFormats.value = response.time_formats
|
|
return timeFormats.value
|
|
} catch (err: unknown) {
|
|
handleApiError(err)
|
|
throw err
|
|
}
|
|
}
|
|
|
|
async function fetchTimeZones(): Promise<Array<{ key: string; value: string }>> {
|
|
if (timeZones.value.length) {
|
|
return timeZones.value
|
|
}
|
|
|
|
try {
|
|
const response = await settingService.getTimezones()
|
|
timeZones.value = response.time_zones
|
|
return timeZones.value
|
|
} catch (err: unknown) {
|
|
handleApiError(err)
|
|
throw err
|
|
}
|
|
}
|
|
|
|
async function fetchCountries(): Promise<Country[]> {
|
|
if (countries.value.length) {
|
|
return countries.value
|
|
}
|
|
|
|
try {
|
|
const response = await settingService.getCountries()
|
|
countries.value = response.data
|
|
return countries.value
|
|
} catch (err: unknown) {
|
|
handleApiError(err)
|
|
throw err
|
|
}
|
|
}
|
|
|
|
async function fetchPlaceholders(
|
|
params: NumberPlaceholdersParams
|
|
): Promise<{ placeholders: NumberPlaceholder[] }> {
|
|
try {
|
|
return await settingService.getNumberPlaceholders(params)
|
|
} catch (err: unknown) {
|
|
handleApiError(err)
|
|
throw err
|
|
}
|
|
}
|
|
|
|
function setSidebarVisibility(val: boolean): void {
|
|
isSidebarOpen.value = val
|
|
}
|
|
|
|
function toggleSidebarCollapse(): void {
|
|
isSidebarCollapsed.value = !isSidebarCollapsed.value
|
|
localStore.set('sidebarCollapsed', isSidebarCollapsed.value)
|
|
}
|
|
|
|
function setIsAppLoaded(loaded: boolean): void {
|
|
isAppLoaded.value = loaded
|
|
}
|
|
|
|
async function updateGlobalSettings(params: {
|
|
data: GlobalSettingsPayload
|
|
message?: string
|
|
}): Promise<void> {
|
|
try {
|
|
await settingService.updateGlobalSettings(params.data)
|
|
|
|
if (globalSettings.value) {
|
|
Object.assign(
|
|
globalSettings.value,
|
|
params.data.settings
|
|
)
|
|
}
|
|
|
|
if (params.message) {
|
|
const notificationStore = useNotificationStore()
|
|
notificationStore.showNotification({
|
|
type: 'success',
|
|
message: params.message,
|
|
})
|
|
}
|
|
} catch (err: unknown) {
|
|
handleApiError(err)
|
|
throw err
|
|
}
|
|
}
|
|
|
|
return {
|
|
// State
|
|
config,
|
|
globalSettings,
|
|
timeZones,
|
|
dateFormats,
|
|
timeFormats,
|
|
currencies,
|
|
countries,
|
|
languages,
|
|
fiscalYears,
|
|
mainMenu,
|
|
settingMenu,
|
|
userMenu,
|
|
ai,
|
|
isAppLoaded,
|
|
isSidebarOpen,
|
|
isSidebarCollapsed,
|
|
areCurrenciesLoading,
|
|
downloadReport,
|
|
// Getters
|
|
menuGroups,
|
|
// Actions
|
|
bootstrap,
|
|
fetchCurrencies,
|
|
fetchConfig,
|
|
fetchDateFormats,
|
|
fetchTimeFormats,
|
|
fetchTimeZones,
|
|
fetchCountries,
|
|
fetchPlaceholders,
|
|
setSidebarVisibility,
|
|
toggleSidebarCollapse,
|
|
setIsAppLoaded,
|
|
updateGlobalSettings,
|
|
}
|
|
})
|