settingsSchema.ts 7.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149
  1. import { z } from 'zod'
  2. export const SETTING_KEYS = {
  3. COMPANY_LOGO: 'workshop.logo',
  4. WORKSHOP_ADDRESS: 'workshop.address',
  5. WORKSHOP_PHONE: 'workshop.phone',
  6. WORKSHOP_EMAIL: 'workshop.email',
  7. DEFAULT_TAX_RATE: 'workshop.defaultTaxRate',
  8. TAX_ENABLED: 'workshop.taxEnabled',
  9. TAX_INCLUSIVE: 'workshop.taxInclusive',
  10. TAX_LABEL: 'workshop.taxLabel',
  11. INVOICE_PREFIX: 'workshop.invoicePrefix',
  12. INVOICE_START_NUMBER: 'workshop.invoiceStartNumber',
  13. CURRENCY_SYMBOL: 'workshop.currencySymbol',
  14. CURRENCY_CODE: 'workshop.currencyCode',
  15. CURRENCY_FORMAT: 'workshop.currencyFormat',
  16. INVOICE_BANK_ACCOUNT: 'invoice.bankAccount',
  17. INVOICE_ORG_NUMBER: 'invoice.orgNumber',
  18. INVOICE_PAYMENT_TERMS: 'invoice.paymentTerms',
  19. INVOICE_FOOTER_NOTE: 'invoice.footerNote',
  20. INVOICE_SHOW_BANK_ACCOUNT: 'invoice.showBankAccount',
  21. INVOICE_SHOW_ORG_NUMBER: 'invoice.showOrgNumber',
  22. INVOICE_DUE_DAYS: 'invoice.dueDays',
  23. UNIT_SYSTEM: 'workshop.unitSystem',
  24. DEFAULT_TECHNICIAN: 'workshop.defaultTechnician',
  25. DEFAULT_TECHNICIAN_ID: 'workshop.defaultTechnicianId',
  26. DEFAULT_LABOR_RATE: 'workshop.defaultLaborRate',
  27. QUOTE_PREFIX: 'workshop.quotePrefix',
  28. QUOTE_VALID_DAYS: 'workshop.quoteValidDays',
  29. EMAIL_FROM_NAME: 'email.fromName',
  30. EMAIL_ENABLED: 'email.enabled',
  31. INVOICE_TEMPLATE: 'invoice.template',
  32. INVOICE_PRIMARY_COLOR: 'invoice.primaryColor',
  33. INVOICE_FONT_FAMILY: 'invoice.fontFamily',
  34. INVOICE_SHOW_LOGO: 'invoice.showLogo',
  35. INVOICE_SHOW_COMPANY_NAME: 'invoice.showCompanyName',
  36. INVOICE_HEADER_STYLE: 'invoice.headerStyle',
  37. INVOICE_LOGO_SIZE: 'invoice.logoSize',
  38. QUOTE_LOGO_SIZE: 'quote.logoSize',
  39. PAYMENT_PROVIDERS_ENABLED: 'payment.providersEnabled',
  40. PAYMENT_STRIPE_SECRET_KEY: 'payment.stripe.secretKey',
  41. PAYMENT_STRIPE_PUBLISHABLE_KEY: 'payment.stripe.publishableKey',
  42. PAYMENT_STRIPE_WEBHOOK_SECRET: 'payment.stripe.webhookSecret',
  43. PAYMENT_VIPPS_CLIENT_ID: 'payment.vipps.clientId',
  44. PAYMENT_VIPPS_CLIENT_SECRET: 'payment.vipps.clientSecret',
  45. PAYMENT_VIPPS_SUBSCRIPTION_KEY: 'payment.vipps.subscriptionKey',
  46. PAYMENT_VIPPS_MSN: 'payment.vipps.merchantSerialNumber',
  47. PAYMENT_VIPPS_USE_TEST: 'payment.vipps.useTestMode',
  48. PAYMENT_PAYPAL_CLIENT_ID: 'payment.paypal.clientId',
  49. PAYMENT_PAYPAL_CLIENT_SECRET: 'payment.paypal.clientSecret',
  50. PAYMENT_PAYPAL_USE_SANDBOX: 'payment.paypal.useSandbox',
  51. PAYMENT_TERMS_OF_SALE: 'payment.termsOfSale',
  52. PAYMENT_TERMS_OF_SALE_URL: 'payment.termsOfSaleUrl',
  53. LICENSE_KEY: 'license.key',
  54. LICENSE_VALID: 'license.valid',
  55. LICENSE_CHECKED_AT: 'license.checkedAt',
  56. LICENSE_PLAN: 'license.plan',
  57. LICENSE_EXPIRES_AT: 'license.expiresAt',
  58. DATE_FORMAT: 'workshop.dateFormat',
  59. TIME_FORMAT: 'workshop.timeFormat',
  60. TIMEZONE: 'workshop.timezone',
  61. QUOTE_PRIMARY_COLOR: 'quote.primaryColor',
  62. QUOTE_FONT_FAMILY: 'quote.fontFamily',
  63. QUOTE_HEADER_STYLE: 'quote.headerStyle',
  64. PREDICTED_MAINTENANCE_ENABLED: 'maintenance.enabled',
  65. MAINTENANCE_SERVICE_INTERVAL: 'maintenance.serviceInterval',
  66. MAINTENANCE_APPROACHING_THRESHOLD: 'maintenance.approachingThreshold',
  67. INVENTORY_MARKUP_MULTIPLIER: 'inventory.markupMultiplier',
  68. LOW_STOCK_ALERTS_ENABLED: 'inventory.lowStockAlerts.enabled',
  69. /// Org-wide fallback reorder point, applied to parts with no minQuantity of
  70. /// their own. 0 means only explicitly configured parts are watched.
  71. LOW_STOCK_DEFAULT_THRESHOLD: 'inventory.lowStockAlerts.defaultThreshold',
  72. LOW_STOCK_ALERTS_IN_APP: 'inventory.lowStockAlerts.inApp',
  73. LOW_STOCK_ALERTS_EMAIL: 'inventory.lowStockAlerts.email',
  74. LOW_STOCK_ALERTS_EMAIL_MIN_INTERVAL_HOURS: 'inventory.lowStockAlerts.emailMinIntervalHours',
  75. /// Internal bookkeeping — the last time a digest actually went out, used to
  76. /// enforce the minimum interval. Not user-editable.
  77. LOW_STOCK_ALERTS_LAST_EMAIL_AT: 'inventory.lowStockAlerts.lastEmailAt',
  78. PARTS_DEFAULT_MARKUP_PERCENT: 'parts.defaultMarkupPercent',
  79. PARTS_MARKUP_APPLIES_TO_INVENTORY: 'parts.markupAppliesToInventory',
  80. SMS_TEMPLATE_INVOICE_READY: 'sms.template.invoiceReady',
  81. SMS_TEMPLATE_QUOTE_READY: 'sms.template.quoteReady',
  82. SMS_TEMPLATE_INSPECTION_READY: 'sms.template.inspectionReady',
  83. SMS_TEMPLATE_STATUS_IN_PROGRESS: 'sms.template.statusInProgress',
  84. SMS_TEMPLATE_STATUS_WAITING_PARTS: 'sms.template.statusWaitingParts',
  85. SMS_TEMPLATE_STATUS_READY: 'sms.template.statusReady',
  86. SMS_TEMPLATE_STATUS_COMPLETED: 'sms.template.statusCompleted',
  87. SMS_TEMPLATE_PAYMENT_RECEIVED: 'sms.template.paymentReceived',
  88. // Telegram templates
  89. TELEGRAM_TEMPLATE_INVOICE_READY: 'telegram.template.invoiceReady',
  90. TELEGRAM_TEMPLATE_QUOTE_READY: 'telegram.template.quoteReady',
  91. TELEGRAM_TEMPLATE_STATUS_IN_PROGRESS: 'telegram.template.statusInProgress',
  92. TELEGRAM_TEMPLATE_STATUS_COMPLETED: 'telegram.template.statusCompleted',
  93. TELEGRAM_TEMPLATE_PAYMENT_RECEIVED: 'telegram.template.paymentReceived',
  94. TELEGRAM_SHOW_QR_ON_INVOICE: 'telegram.showQrOnInvoice',
  95. PORTAL_ENABLED: 'portal.enabled',
  96. PORTAL_DESCRIPTION: 'portal.description',
  97. PORTAL_HOURS: 'portal.hours',
  98. /// Off by default. Every service request already raises an in-app
  99. /// notification; this adds email on top, and stays opt-in because a workshop
  100. /// with no mail provider configured would otherwise generate failed sends.
  101. SERVICE_REQUEST_ALERTS_EMAIL: 'portal.serviceRequestAlerts.email',
  102. /// Optional free-text list of addresses. Empty means the alert goes to every
  103. /// owner and admin in the organization.
  104. SERVICE_REQUEST_ALERTS_RECIPIENTS: 'portal.serviceRequestAlerts.recipients',
  105. PORTAL_BACKGROUND_TYPE: 'portal.background.type',
  106. PORTAL_BACKGROUND_TEMPLATE: 'portal.background.template',
  107. PORTAL_BACKGROUND_IMAGE: 'portal.background.image',
  108. WORKBOARD_WEEK_START_DAY: 'workboard.weekStartDay',
  109. WORKBOARD_WORK_DAY_START: 'workboard.workDayStart',
  110. WORKBOARD_WORK_DAY_END: 'workboard.workDayEnd',
  111. INVOICE_LAYOUT_CONFIG: 'invoice.layoutConfig',
  112. QUOTE_LAYOUT_CONFIG: 'quote.layoutConfig',
  113. AI_PROVIDER: 'ai.provider',
  114. AI_API_KEY: 'ai.apiKey',
  115. AI_MODEL: 'ai.model',
  116. AI_ENABLED: 'ai.enabled',
  117. SERVICE_TYPE: 'workshop.serviceType',
  118. WORKSHOP_LOCALE: 'workshop.locale',
  119. WORKSHOP_DEFAULT_COUNTRY_CODE: 'workshop.defaultCountryCode',
  120. FORCE_CUSTOMER_LOCALE: 'workshop.forceCustomerLocale',
  121. DEFAULT_WARRANTY_MONTHS: 'defaultWarrantyMonths',
  122. DEFAULT_WARRANTY_MILEAGE: 'defaultWarrantyMileage',
  123. DEFAULT_WARRANTY_NOTES: 'defaultWarrantyNotes',
  124. } as const
  125. export type SettingKey = (typeof SETTING_KEYS)[keyof typeof SETTING_KEYS]
  126. export const workshopSettingsSchema = z.object({
  127. [SETTING_KEYS.WORKSHOP_ADDRESS]: z.string().optional(),
  128. [SETTING_KEYS.WORKSHOP_PHONE]: z.string().optional(),
  129. [SETTING_KEYS.WORKSHOP_EMAIL]: z.string().email('Invalid email').optional().or(z.literal('')),
  130. [SETTING_KEYS.DEFAULT_TAX_RATE]: z.string().optional(),
  131. [SETTING_KEYS.INVOICE_PREFIX]: z.string().optional(),
  132. [SETTING_KEYS.CURRENCY_SYMBOL]: z.string().optional(),
  133. })
  134. export const invoiceSettingsSchema = z.object({
  135. [SETTING_KEYS.INVOICE_BANK_ACCOUNT]: z.string().optional(),
  136. [SETTING_KEYS.INVOICE_ORG_NUMBER]: z.string().optional(),
  137. [SETTING_KEYS.INVOICE_PAYMENT_TERMS]: z.string().optional(),
  138. [SETTING_KEYS.INVOICE_FOOTER_NOTE]: z.string().optional(),
  139. [SETTING_KEYS.INVOICE_SHOW_BANK_ACCOUNT]: z.string().optional(),
  140. [SETTING_KEYS.INVOICE_SHOW_ORG_NUMBER]: z.string().optional(),
  141. [SETTING_KEYS.INVOICE_DUE_DAYS]: z.string().optional(),
  142. })
  143. export type WorkshopSettings = z.infer<typeof workshopSettingsSchema>
  144. export type InvoiceSettings = z.infer<typeof invoiceSettingsSchema>