fd1db89603
* feat: make invoice_number nullable and assign on send - Updated the invoices table to allow invoice_number to be nullable. - Modified the logic to assign invoice numbers only when the invoice status transitions to 'sent'. - Refactored related code to handle nullable invoice numbers, including UI components and API routes. - Added tests to ensure correct behavior when handling invoices with null invoice numbers. - Introduced a utility function to display invoice numbers, defaulting to '(Utkast)' for drafts. * fix: update fiscal period handling to return names of open periods in error messages * fix: enhance period creation logic to account for company-wide bookkeeping lock-through * fix: remove unnecessary customer_type field from customer insertion query * fix: scope invoice number count query to specific companies to avoid test interference * feat: Implement atomic invoice number generation and ensure compliance with invoice numbering rules - Introduced `ensureInvoiceNumber` function to assign invoice numbers atomically, handling concurrency and ensuring compliance with document types. - Updated invoice-related components to utilize the new `invoiceNumberDisplay` utility for consistent invoice number formatting. - Added checks to ensure that invoices in non-draft statuses have valid invoice numbers, preventing violations of legal requirements. - Created tests for the new invoice number generation logic, ensuring correct behavior under various scenarios, including concurrent requests. - Added a draft banner to PDF templates for invoices without assigned numbers, clarifying their status to users. - Updated database migrations to support the new atomic invoice number generation logic and enforce constraints on invoice statuses.
265 lines
8.4 KiB
TypeScript
265 lines
8.4 KiB
TypeScript
/**
|
|
* Push Notifications Extension
|
|
*
|
|
* Converts system events into instant push notifications.
|
|
* Also provides cron-based scheduling for time-dependent checks
|
|
* (tax deadlines, invoice due/overdue).
|
|
*
|
|
* Event handlers follow the gate pattern:
|
|
* check extension setting -> build payload -> send via unified pipeline
|
|
*/
|
|
|
|
import type { Extension, ExtensionContext } from '@/lib/extensions/types'
|
|
import type { EventPayload } from '@/lib/events/types'
|
|
import { pushNotificationsApiRoutes } from './api-routes'
|
|
import { sendNotificationToUser } from './notification-sender'
|
|
import {
|
|
createPeriodLockedPayload,
|
|
createYearClosedPayload,
|
|
createInvoiceSentPayload,
|
|
createReceiptExtractedPayload,
|
|
createReceiptMatchedPayload,
|
|
} from './payload-builders'
|
|
import { invoiceNumberDisplay } from '@/lib/invoices/display'
|
|
|
|
// ============================================================
|
|
// Settings
|
|
// ============================================================
|
|
|
|
export interface PushNotificationSettings {
|
|
periodLockedEnabled: boolean
|
|
periodYearClosedEnabled: boolean
|
|
invoiceSentEnabled: boolean
|
|
receiptExtractedEnabled: boolean
|
|
receiptMatchedEnabled: boolean
|
|
missingUnderlagEnabled: boolean
|
|
}
|
|
|
|
const DEFAULT_SETTINGS: PushNotificationSettings = {
|
|
periodLockedEnabled: true,
|
|
periodYearClosedEnabled: true,
|
|
invoiceSentEnabled: false,
|
|
receiptExtractedEnabled: true,
|
|
receiptMatchedEnabled: true,
|
|
missingUnderlagEnabled: true,
|
|
}
|
|
|
|
/** Get settings via ExtensionContext (preferred in event handlers) */
|
|
async function getSettingsViaCtx(ctx: ExtensionContext): Promise<PushNotificationSettings> {
|
|
const stored = await ctx.settings.get<Partial<PushNotificationSettings>>()
|
|
return { ...DEFAULT_SETTINGS, ...(stored || {}) }
|
|
}
|
|
|
|
/** Get settings for external callers (settings routes, cron jobs) */
|
|
export async function getSettings(userId: string): Promise<PushNotificationSettings> {
|
|
const { createClient } = await import('@/lib/supabase/server')
|
|
const supabase = await createClient()
|
|
|
|
const { data } = await supabase
|
|
.from('notification_settings')
|
|
.select(
|
|
'period_locked_enabled, period_year_closed_enabled, invoice_sent_enabled, receipt_extracted_enabled, receipt_matched_enabled, missing_underlag_enabled'
|
|
)
|
|
.eq('company_id', userId)
|
|
.single()
|
|
|
|
if (!data) return { ...DEFAULT_SETTINGS }
|
|
return {
|
|
periodLockedEnabled: data.period_locked_enabled ?? DEFAULT_SETTINGS.periodLockedEnabled,
|
|
periodYearClosedEnabled: data.period_year_closed_enabled ?? DEFAULT_SETTINGS.periodYearClosedEnabled,
|
|
invoiceSentEnabled: data.invoice_sent_enabled ?? DEFAULT_SETTINGS.invoiceSentEnabled,
|
|
receiptExtractedEnabled: data.receipt_extracted_enabled ?? DEFAULT_SETTINGS.receiptExtractedEnabled,
|
|
receiptMatchedEnabled: data.receipt_matched_enabled ?? DEFAULT_SETTINGS.receiptMatchedEnabled,
|
|
missingUnderlagEnabled: data.missing_underlag_enabled ?? DEFAULT_SETTINGS.missingUnderlagEnabled,
|
|
}
|
|
}
|
|
|
|
export async function saveSettings(
|
|
userId: string,
|
|
partial: Partial<PushNotificationSettings>
|
|
): Promise<PushNotificationSettings> {
|
|
const current = await getSettings(userId)
|
|
const merged = { ...current, ...partial }
|
|
|
|
const { createClient } = await import('@/lib/supabase/server')
|
|
const supabase = await createClient()
|
|
|
|
await supabase
|
|
.from('notification_settings')
|
|
.upsert(
|
|
{
|
|
user_id: userId,
|
|
period_locked_enabled: merged.periodLockedEnabled,
|
|
period_year_closed_enabled: merged.periodYearClosedEnabled,
|
|
invoice_sent_enabled: merged.invoiceSentEnabled,
|
|
receipt_extracted_enabled: merged.receiptExtractedEnabled,
|
|
receipt_matched_enabled: merged.receiptMatchedEnabled,
|
|
missing_underlag_enabled: merged.missingUnderlagEnabled,
|
|
},
|
|
{ onConflict: 'user_id' }
|
|
)
|
|
|
|
return merged
|
|
}
|
|
|
|
// ============================================================
|
|
// Event Handlers
|
|
// ============================================================
|
|
|
|
async function handlePeriodLocked(
|
|
payload: EventPayload<'period.locked'>,
|
|
ctx?: ExtensionContext
|
|
): Promise<void> {
|
|
const { period, userId } = payload
|
|
|
|
const settings = ctx ? await getSettingsViaCtx(ctx) : await getSettings(userId)
|
|
if (!settings.periodLockedEnabled) return
|
|
|
|
const supabase = ctx?.supabase ?? await (await import('@/lib/supabase/server')).createClient()
|
|
const notificationPayload = createPeriodLockedPayload(period.name, period.id)
|
|
|
|
const result = await sendNotificationToUser(
|
|
supabase,
|
|
userId,
|
|
notificationPayload,
|
|
'period_locked',
|
|
period.id
|
|
)
|
|
|
|
if (result.sent) {
|
|
(ctx?.log ?? console).info(`Period locked notification sent for ${period.name}`)
|
|
}
|
|
}
|
|
|
|
async function handleYearClosed(
|
|
payload: EventPayload<'period.year_closed'>,
|
|
ctx?: ExtensionContext
|
|
): Promise<void> {
|
|
const { period, userId } = payload
|
|
|
|
const settings = ctx ? await getSettingsViaCtx(ctx) : await getSettings(userId)
|
|
if (!settings.periodYearClosedEnabled) return
|
|
|
|
const supabase = ctx?.supabase ?? await (await import('@/lib/supabase/server')).createClient()
|
|
const notificationPayload = createYearClosedPayload(period.name, period.id)
|
|
|
|
const result = await sendNotificationToUser(
|
|
supabase,
|
|
userId,
|
|
notificationPayload,
|
|
'period_year_closed',
|
|
period.id
|
|
)
|
|
|
|
if (result.sent) {
|
|
(ctx?.log ?? console).info(`Year closed notification sent for ${period.name}`)
|
|
}
|
|
}
|
|
|
|
async function handleInvoiceSent(
|
|
payload: EventPayload<'invoice.sent'>,
|
|
ctx?: ExtensionContext
|
|
): Promise<void> {
|
|
const { invoice, userId } = payload
|
|
|
|
const settings = ctx ? await getSettingsViaCtx(ctx) : await getSettings(userId)
|
|
if (!settings.invoiceSentEnabled) return
|
|
|
|
const supabase = ctx?.supabase ?? await (await import('@/lib/supabase/server')).createClient()
|
|
const notificationPayload = createInvoiceSentPayload(
|
|
invoiceNumberDisplay(invoice.invoice_number),
|
|
invoice.id
|
|
)
|
|
|
|
const result = await sendNotificationToUser(
|
|
supabase,
|
|
userId,
|
|
notificationPayload,
|
|
'invoice_sent',
|
|
invoice.id
|
|
)
|
|
|
|
if (result.sent) {
|
|
(ctx?.log ?? console).info(`Invoice sent notification for #${invoice.invoice_number}`)
|
|
}
|
|
}
|
|
|
|
async function handleReceiptExtracted(
|
|
payload: EventPayload<'receipt.extracted'>,
|
|
ctx?: ExtensionContext
|
|
): Promise<void> {
|
|
const { receipt, userId } = payload
|
|
|
|
const settings = ctx ? await getSettingsViaCtx(ctx) : await getSettings(userId)
|
|
if (!settings.receiptExtractedEnabled) return
|
|
|
|
const supabase = ctx?.supabase ?? await (await import('@/lib/supabase/server')).createClient()
|
|
const notificationPayload = createReceiptExtractedPayload(
|
|
receipt.merchant_name,
|
|
receipt.id
|
|
)
|
|
|
|
const result = await sendNotificationToUser(
|
|
supabase,
|
|
userId,
|
|
notificationPayload,
|
|
'receipt_extracted',
|
|
receipt.id
|
|
)
|
|
|
|
if (result.sent) {
|
|
(ctx?.log ?? console).info(`Receipt extracted notification for ${receipt.id}`)
|
|
}
|
|
}
|
|
|
|
async function handleReceiptMatched(
|
|
payload: EventPayload<'receipt.matched'>,
|
|
ctx?: ExtensionContext
|
|
): Promise<void> {
|
|
const { receipt, transaction, userId } = payload
|
|
|
|
const settings = ctx ? await getSettingsViaCtx(ctx) : await getSettings(userId)
|
|
if (!settings.receiptMatchedEnabled) return
|
|
|
|
const supabase = ctx?.supabase ?? await (await import('@/lib/supabase/server')).createClient()
|
|
const notificationPayload = createReceiptMatchedPayload(receipt.id, transaction.id)
|
|
|
|
const result = await sendNotificationToUser(
|
|
supabase,
|
|
userId,
|
|
notificationPayload,
|
|
'receipt_matched',
|
|
receipt.id
|
|
)
|
|
|
|
if (result.sent) {
|
|
(ctx?.log ?? console).info(`Receipt matched notification for ${receipt.id}`)
|
|
}
|
|
}
|
|
|
|
// ============================================================
|
|
// Extension Object
|
|
// ============================================================
|
|
|
|
export const pushNotificationsExtension: Extension = {
|
|
id: 'push-notifications',
|
|
name: 'Push-notiser',
|
|
version: '1.0.0',
|
|
sector: 'general',
|
|
apiRoutes: pushNotificationsApiRoutes,
|
|
eventHandlers: [
|
|
{ eventType: 'period.locked', handler: handlePeriodLocked },
|
|
{ eventType: 'period.year_closed', handler: handleYearClosed },
|
|
{ eventType: 'invoice.sent', handler: handleInvoiceSent },
|
|
{ eventType: 'receipt.extracted', handler: handleReceiptExtracted },
|
|
{ eventType: 'receipt.matched', handler: handleReceiptMatched },
|
|
],
|
|
settingsPanel: {
|
|
label: 'Push-notiser',
|
|
path: '/settings/extensions/push-notifications',
|
|
},
|
|
async onInstall(ctx) {
|
|
await ctx.settings.set('settings', DEFAULT_SETTINGS)
|
|
},
|
|
}
|