@voyantjs/finance 0.2.0 → 0.3.0

package/dist/validation-billing.js

@@ -0,0 +1,219 @@
+import { z } from "zod";
+import { commissionModelSchema, commissionRecipientTypeSchema, commissionStatusSchema, creditNoteStatusSchema, invoiceStatusSchema, paginationSchema, taxScopeSchema, } from "./validation-shared.js";
+const bookingItemTaxLineCoreSchema = z.object({
+    code: z.string().max(100).optional().nullable(),
+    name: z.string().min(1).max(255),
+    jurisdiction: z.string().max(255).optional().nullable(),
+    scope: taxScopeSchema.default("excluded"),
+    currency: z.string().min(3).max(3),
+    amountCents: z.number().int(),
+    rateBasisPoints: z.number().int().min(0).optional().nullable(),
+    includedInPrice: z.boolean().default(false),
+    remittanceParty: z.string().max(255).optional().nullable(),
+    sortOrder: z.number().int().min(0).default(0),
+});
+export const insertBookingItemTaxLineSchema = bookingItemTaxLineCoreSchema;
+export const updateBookingItemTaxLineSchema = bookingItemTaxLineCoreSchema.partial();
+const bookingItemCommissionCoreSchema = z.object({
+    channelId: z.string().optional().nullable(),
+    recipientType: commissionRecipientTypeSchema,
+    commissionModel: commissionModelSchema.default("percentage"),
+    currency: z.string().min(3).max(3).optional().nullable(),
+    amountCents: z.number().int().optional().nullable(),
+    rateBasisPoints: z.number().int().min(0).optional().nullable(),
+    status: commissionStatusSchema.default("pending"),
+    payableAt: z.string().optional().nullable(),
+    paidAt: z.string().optional().nullable(),
+    notes: z.string().optional().nullable(),
+});
+export const insertBookingItemCommissionSchema = bookingItemCommissionCoreSchema;
+export const updateBookingItemCommissionSchema = bookingItemCommissionCoreSchema.partial();
+const invoiceCoreSchema = z.object({
+    invoiceNumber: z.string().min(1).max(50),
+    bookingId: z.string().min(1),
+    personId: z.string().optional().nullable(),
+    organizationId: z.string().optional().nullable(),
+    status: invoiceStatusSchema.default("draft"),
+    currency: z.string().min(3).max(3),
+    baseCurrency: z.string().min(3).max(3).optional().nullable(),
+    fxRateSetId: z.string().optional().nullable(),
+    subtotalCents: z.number().int().min(0).default(0),
+    baseSubtotalCents: z.number().int().min(0).optional().nullable(),
+    taxCents: z.number().int().min(0).default(0),
+    baseTaxCents: z.number().int().min(0).optional().nullable(),
+    totalCents: z.number().int().min(0).default(0),
+    baseTotalCents: z.number().int().min(0).optional().nullable(),
+    paidCents: z.number().int().min(0).default(0),
+    basePaidCents: z.number().int().min(0).optional().nullable(),
+    balanceDueCents: z.number().int().min(0).default(0),
+    baseBalanceDueCents: z.number().int().min(0).optional().nullable(),
+    commissionPercent: z.number().int().min(0).max(100).optional().nullable(),
+    commissionAmountCents: z.number().int().min(0).optional().nullable(),
+    issueDate: z.string().min(1),
+    dueDate: z.string().min(1),
+    notes: z.string().optional().nullable(),
+});
+export const insertInvoiceSchema = invoiceCoreSchema;
+export const updateInvoiceSchema = invoiceCoreSchema.partial();
+export const invoiceListQuerySchema = z.object({
+    status: invoiceStatusSchema.optional(),
+    bookingId: z.string().optional(),
+    search: z.string().optional(),
+    limit: z.coerce.number().int().min(1).max(100).default(50),
+    offset: z.coerce.number().int().min(0).default(0),
+});
+export const invoiceFromBookingSchema = z.object({
+    bookingId: z.string().min(1),
+    invoiceNumber: z.string().min(1).max(50),
+    issueDate: z.string().min(1),
+    dueDate: z.string().min(1),
+    notes: z.string().optional().nullable(),
+});
+const lineItemCoreSchema = z.object({
+    bookingItemId: z.string().optional().nullable(),
+    description: z.string().min(1).max(1000),
+    quantity: z.number().int().min(1).default(1),
+    unitPriceCents: z.number().int().min(0),
+    totalCents: z.number().int().min(0),
+    taxRate: z.number().int().min(0).optional().nullable(),
+    sortOrder: z.number().int().min(0).default(0),
+});
+export const insertInvoiceLineItemSchema = lineItemCoreSchema;
+export const updateInvoiceLineItemSchema = lineItemCoreSchema.partial();
+const creditNoteCoreSchema = z.object({
+    creditNoteNumber: z.string().min(1).max(50),
+    status: creditNoteStatusSchema.default("draft"),
+    amountCents: z.number().int().min(1),
+    currency: z.string().min(3).max(3),
+    baseCurrency: z.string().min(3).max(3).optional().nullable(),
+    baseAmountCents: z.number().int().min(0).optional().nullable(),
+    fxRateSetId: z.string().optional().nullable(),
+    reason: z.string().min(1).max(1000),
+    notes: z.string().optional().nullable(),
+});
+export const insertCreditNoteSchema = creditNoteCoreSchema;
+export const updateCreditNoteSchema = creditNoteCoreSchema.partial();
+const creditNoteLineItemCoreSchema = z.object({
+    description: z.string().min(1).max(1000),
+    quantity: z.number().int().min(1).default(1),
+    unitPriceCents: z.number().int().min(0),
+    totalCents: z.number().int().min(0),
+    sortOrder: z.number().int().min(0).default(0),
+});
+export const insertCreditNoteLineItemSchema = creditNoteLineItemCoreSchema;
+export const updateCreditNoteLineItemSchema = creditNoteLineItemCoreSchema.partial();
+export const insertFinanceNoteSchema = z.object({
+    content: z.string().min(1).max(10000),
+});
+export const revenueReportQuerySchema = z.object({ from: z.string().min(1), to: z.string().min(1) });
+export const agingReportQuerySchema = z.object({ asOf: z.string().optional() });
+export const profitabilityQuerySchema = z.object({
+    from: z.string().optional(),
+    to: z.string().optional(),
+});
+const invoiceNumberResetStrategySchema = z.enum(["never", "annual", "monthly"]);
+const invoiceNumberSeriesScopeSchema = z.enum(["invoice", "proforma", "credit_note"]);
+const invoiceNumberSeriesCoreSchema = z.object({
+    code: z.string().min(1).max(100),
+    name: z.string().min(1).max(255),
+    prefix: z.string().max(50).default(""),
+    separator: z.string().max(10).default(""),
+    padLength: z.number().int().min(0).max(20).default(4),
+    currentSequence: z.number().int().min(0).default(0),
+    resetStrategy: invoiceNumberResetStrategySchema.default("never"),
+    resetAt: z.string().optional().nullable(),
+    scope: invoiceNumberSeriesScopeSchema.default("invoice"),
+    active: z.boolean().default(true),
+});
+export const insertInvoiceNumberSeriesSchema = invoiceNumberSeriesCoreSchema;
+export const updateInvoiceNumberSeriesSchema = invoiceNumberSeriesCoreSchema.partial();
+export const invoiceNumberSeriesListQuerySchema = paginationSchema.extend({
+    scope: invoiceNumberSeriesScopeSchema.optional(),
+    active: z.coerce.boolean().optional(),
+});
+export const allocateInvoiceNumberInputSchema = z.object({ seriesId: z.string().min(1) });
+const invoiceTemplateBodyFormatSchema = z.enum(["html", "markdown", "lexical_json"]);
+const invoiceTemplateCoreSchema = z.object({
+    name: z.string().min(1).max(255),
+    slug: z
+        .string()
+        .min(1)
+        .max(100)
+        .regex(/^[a-z0-9-]+$/, "slug must be kebab-case"),
+    language: z.string().min(2).max(10).default("en"),
+    jurisdiction: z.string().max(10).optional().nullable(),
+    bodyFormat: invoiceTemplateBodyFormatSchema.default("html"),
+    body: z.string().min(1),
+    cssStyles: z.string().optional().nullable(),
+    isDefault: z.boolean().default(false),
+    active: z.boolean().default(true),
+    metadata: z.record(z.string(), z.unknown()).optional().nullable(),
+});
+export const insertInvoiceTemplateSchema = invoiceTemplateCoreSchema;
+export const updateInvoiceTemplateSchema = invoiceTemplateCoreSchema.partial();
+export const invoiceTemplateListQuerySchema = paginationSchema.extend({
+    language: z.string().optional(),
+    jurisdiction: z.string().optional(),
+    active: z.coerce.boolean().optional(),
+    search: z.string().optional(),
+});
+const invoiceRenditionFormatSchema = z.enum(["html", "pdf", "xml", "json"]);
+const invoiceRenditionStatusSchema = z.enum(["pending", "ready", "failed", "stale"]);
+const invoiceRenditionCoreSchema = z.object({
+    templateId: z.string().optional().nullable(),
+    format: invoiceRenditionFormatSchema.default("pdf"),
+    status: invoiceRenditionStatusSchema.default("pending"),
+    storageKey: z.string().optional().nullable(),
+    fileSize: z.number().int().min(0).optional().nullable(),
+    checksum: z.string().optional().nullable(),
+    language: z.string().optional().nullable(),
+    errorMessage: z.string().optional().nullable(),
+    generatedAt: z.string().optional().nullable(),
+    metadata: z.record(z.string(), z.unknown()).optional().nullable(),
+});
+export const insertInvoiceRenditionSchema = invoiceRenditionCoreSchema;
+export const updateInvoiceRenditionSchema = invoiceRenditionCoreSchema.partial();
+const taxRegimeCodeSchema = z.enum([
+    "standard",
+    "reduced",
+    "exempt",
+    "reverse_charge",
+    "margin_scheme_art311",
+    "zero_rated",
+    "out_of_scope",
+    "other",
+]);
+const taxRegimeCoreSchema = z.object({
+    code: taxRegimeCodeSchema,
+    name: z.string().min(1).max(255),
+    jurisdiction: z.string().max(10).optional().nullable(),
+    ratePercent: z.number().int().min(0).max(10000).optional().nullable(),
+    description: z.string().max(2000).optional().nullable(),
+    legalReference: z.string().max(500).optional().nullable(),
+    active: z.boolean().default(true),
+    metadata: z.record(z.string(), z.unknown()).optional().nullable(),
+});
+export const insertTaxRegimeSchema = taxRegimeCoreSchema;
+export const updateTaxRegimeSchema = taxRegimeCoreSchema.partial();
+export const taxRegimeListQuerySchema = paginationSchema.extend({
+    code: taxRegimeCodeSchema.optional(),
+    jurisdiction: z.string().optional(),
+    active: z.coerce.boolean().optional(),
+});
+const invoiceExternalRefCoreSchema = z.object({
+    provider: z.string().min(1).max(100),
+    externalId: z.string().max(255).optional().nullable(),
+    externalNumber: z.string().max(255).optional().nullable(),
+    externalUrl: z.string().max(1000).optional().nullable(),
+    status: z.string().max(100).optional().nullable(),
+    metadata: z.record(z.string(), z.unknown()).optional().nullable(),
+    syncedAt: z.string().optional().nullable(),
+    syncError: z.string().optional().nullable(),
+});
+export const insertInvoiceExternalRefSchema = invoiceExternalRefCoreSchema;
+export const updateInvoiceExternalRefSchema = invoiceExternalRefCoreSchema.partial();
+export const renderInvoiceInputSchema = z.object({
+    templateId: z.string().optional().nullable(),
+    format: invoiceRenditionFormatSchema.default("pdf"),
+    language: z.string().optional().nullable(),
+});