@voyantjs/finance 0.2.0 → 0.3.1

package/dist/validation-public.js

@@ -0,0 +1,166 @@
+import { z } from "zod";
+import { paymentInstrumentStatusSchema, paymentInstrumentTypeSchema, paymentMethodSchema, paymentScheduleStatusSchema, paymentScheduleTypeSchema, paymentSessionStatusSchema, paymentSessionTargetTypeSchema, } from "./validation-shared.js";
+export const publicFinanceInvoiceTypeSchema = z.enum(["invoice", "proforma", "credit_note"]);
+export const publicFinanceDocumentAvailabilitySchema = z.enum([
+    "missing",
+    "pending",
+    "ready",
+    "failed",
+    "stale",
+]);
+export const publicFinanceDocumentFormatSchema = z.enum(["html", "pdf", "xml", "json"]);
+export const publicPaymentOptionsQuerySchema = z.object({
+    personId: z.string().optional(),
+    organizationId: z.string().optional(),
+    provider: z.string().optional(),
+    instrumentType: paymentInstrumentTypeSchema.optional(),
+    includeInactive: z.coerce.boolean().default(false),
+});
+export const publicStartPaymentSessionSchema = z.object({
+    provider: z.string().max(255).optional().nullable(),
+    paymentMethod: paymentMethodSchema.optional().nullable(),
+    paymentInstrumentId: z.string().optional().nullable(),
+    payerPersonId: z.string().optional().nullable(),
+    payerOrganizationId: z.string().optional().nullable(),
+    payerEmail: z.string().email().optional().nullable(),
+    payerName: z.string().max(255).optional().nullable(),
+    externalReference: z.string().max(255).optional().nullable(),
+    idempotencyKey: z.string().max(255).optional().nullable(),
+    clientReference: z.string().max(255).optional().nullable(),
+    returnUrl: z.string().url().optional().nullable(),
+    cancelUrl: z.string().url().optional().nullable(),
+    callbackUrl: z.string().url().optional().nullable(),
+    expiresAt: z.string().optional().nullable(),
+    notes: z.string().optional().nullable(),
+    providerPayload: z.record(z.string(), z.unknown()).optional().nullable(),
+    metadata: z.record(z.string(), z.unknown()).optional().nullable(),
+});
+export const publicValidateVoucherSchema = z.object({
+    code: z.string().min(1).max(255),
+    provider: z.string().max(255).optional().nullable(),
+    bookingId: z.string().optional().nullable(),
+    currency: z.string().min(3).max(3).optional().nullable(),
+    amountCents: z.number().int().min(1).optional().nullable(),
+});
+export const publicPaymentAccountSchema = z.object({
+    id: z.string(),
+    label: z.string(),
+    provider: z.string().nullable(),
+    instrumentType: paymentInstrumentTypeSchema,
+    status: paymentInstrumentStatusSchema,
+    brand: z.string().nullable(),
+    last4: z.string().nullable(),
+    expiryMonth: z.number().int().nullable(),
+    expiryYear: z.number().int().nullable(),
+    isDefault: z.boolean(),
+});
+export const publicBookingPaymentScheduleSchema = z.object({
+    id: z.string(),
+    scheduleType: paymentScheduleTypeSchema,
+    status: paymentScheduleStatusSchema,
+    dueDate: z.string(),
+    currency: z.string(),
+    amountCents: z.number().int(),
+    notes: z.string().nullable(),
+});
+export const publicBookingGuaranteeSchema = z.object({
+    id: z.string(),
+    bookingPaymentScheduleId: z.string().nullable(),
+    guaranteeType: z.string(),
+    status: z.string(),
+    currency: z.string().nullable(),
+    amountCents: z.number().int().nullable(),
+    provider: z.string().nullable(),
+    referenceNumber: z.string().nullable(),
+    expiresAt: z.string().nullable(),
+    notes: z.string().nullable(),
+});
+export const publicBookingPaymentOptionsSchema = z.object({
+    bookingId: z.string(),
+    accounts: z.array(publicPaymentAccountSchema),
+    schedules: z.array(publicBookingPaymentScheduleSchema),
+    guarantees: z.array(publicBookingGuaranteeSchema),
+    recommendedTarget: z
+        .object({
+        targetType: z.enum(["booking_payment_schedule", "booking_guarantee"]).nullable(),
+        targetId: z.string().nullable(),
+    })
+        .nullable(),
+});
+export const publicPaymentSessionSchema = z.object({
+    id: z.string(),
+    targetType: paymentSessionTargetTypeSchema,
+    targetId: z.string().nullable(),
+    bookingId: z.string().nullable(),
+    invoiceId: z.string().nullable(),
+    bookingPaymentScheduleId: z.string().nullable(),
+    bookingGuaranteeId: z.string().nullable(),
+    status: paymentSessionStatusSchema,
+    provider: z.string().nullable(),
+    providerSessionId: z.string().nullable(),
+    providerPaymentId: z.string().nullable(),
+    externalReference: z.string().nullable(),
+    clientReference: z.string().nullable(),
+    currency: z.string(),
+    amountCents: z.number().int(),
+    paymentMethod: paymentMethodSchema.nullable(),
+    payerEmail: z.string().nullable(),
+    payerName: z.string().nullable(),
+    redirectUrl: z.string().nullable(),
+    returnUrl: z.string().nullable(),
+    cancelUrl: z.string().nullable(),
+    expiresAt: z.string().nullable(),
+    completedAt: z.string().nullable(),
+    failureCode: z.string().nullable(),
+    failureMessage: z.string().nullable(),
+});
+export const publicFinanceBookingDocumentSchema = z.object({
+    invoiceId: z.string(),
+    invoiceNumber: z.string(),
+    invoiceType: publicFinanceInvoiceTypeSchema,
+    invoiceStatus: z.enum(["draft", "sent", "partially_paid", "paid", "overdue", "void"]),
+    currency: z.string(),
+    totalCents: z.number().int(),
+    paidCents: z.number().int(),
+    balanceDueCents: z.number().int(),
+    issueDate: z.string(),
+    dueDate: z.string(),
+    renditionId: z.string().nullable(),
+    documentStatus: publicFinanceDocumentAvailabilitySchema,
+    format: publicFinanceDocumentFormatSchema.nullable(),
+    language: z.string().nullable(),
+    generatedAt: z.string().nullable(),
+    fileSize: z.number().int().nullable(),
+    checksum: z.string().nullable(),
+    downloadUrl: z.string().nullable(),
+});
+export const publicBookingFinanceDocumentsSchema = z.object({
+    bookingId: z.string(),
+    documents: z.array(publicFinanceBookingDocumentSchema),
+});
+export const publicVoucherValidationSchema = z.object({
+    valid: z.boolean(),
+    reason: z
+        .enum([
+        "not_found",
+        "inactive",
+        "not_started",
+        "expired",
+        "booking_mismatch",
+        "currency_mismatch",
+        "insufficient_balance",
+    ])
+        .nullable(),
+    voucher: z
+        .object({
+        id: z.string(),
+        code: z.string(),
+        label: z.string(),
+        provider: z.string().nullable(),
+        currency: z.string().nullable(),
+        amountCents: z.number().int().nullable(),
+        remainingAmountCents: z.number().int().nullable(),
+        expiresAt: z.string().nullable(),
+    })
+        .nullable(),
+});

package/dist/validation-shared.d.ts

@@ -0,0 +1,159 @@
+import { z } from "zod";
+export declare const invoiceStatusSchema: z.ZodEnum<{
+    draft: "draft";
+    sent: "sent";
+    partially_paid: "partially_paid";
+    paid: "paid";
+    overdue: "overdue";
+    void: "void";
+}>;
+export declare const paymentMethodSchema: z.ZodEnum<{
+    other: "other";
+    voucher: "voucher";
+    wallet: "wallet";
+    bank_transfer: "bank_transfer";
+    credit_card: "credit_card";
+    debit_card: "debit_card";
+    cash: "cash";
+    cheque: "cheque";
+    direct_bill: "direct_bill";
+}>;
+export declare const paymentStatusSchema: z.ZodEnum<{
+    completed: "completed";
+    pending: "pending";
+    failed: "failed";
+    refunded: "refunded";
+}>;
+export declare const paymentSessionStatusSchema: z.ZodEnum<{
+    expired: "expired";
+    cancelled: "cancelled";
+    pending: "pending";
+    failed: "failed";
+    paid: "paid";
+    requires_redirect: "requires_redirect";
+    processing: "processing";
+    authorized: "authorized";
+}>;
+export declare const paymentSessionTargetTypeSchema: z.ZodEnum<{
+    other: "other";
+    booking: "booking";
+    order: "order";
+    invoice: "invoice";
+    booking_payment_schedule: "booking_payment_schedule";
+    booking_guarantee: "booking_guarantee";
+}>;
+export declare const paymentInstrumentTypeSchema: z.ZodEnum<{
+    other: "other";
+    voucher: "voucher";
+    wallet: "wallet";
+    credit_card: "credit_card";
+    debit_card: "debit_card";
+    cash: "cash";
+    direct_bill: "direct_bill";
+    bank_account: "bank_account";
+}>;
+export declare const paymentInstrumentOwnerTypeSchema: z.ZodEnum<{
+    internal: "internal";
+    supplier: "supplier";
+    other: "other";
+    client: "client";
+    channel: "channel";
+    agency: "agency";
+}>;
+export declare const paymentInstrumentStatusSchema: z.ZodEnum<{
+    expired: "expired";
+    revoked: "revoked";
+    active: "active";
+    inactive: "inactive";
+    failed_verification: "failed_verification";
+}>;
+export declare const paymentAuthorizationStatusSchema: z.ZodEnum<{
+    expired: "expired";
+    pending: "pending";
+    failed: "failed";
+    authorized: "authorized";
+    partially_captured: "partially_captured";
+    captured: "captured";
+    voided: "voided";
+}>;
+export declare const paymentCaptureStatusSchema: z.ZodEnum<{
+    completed: "completed";
+    pending: "pending";
+    failed: "failed";
+    refunded: "refunded";
+    voided: "voided";
+}>;
+export declare const captureModeSchema: z.ZodEnum<{
+    manual: "manual";
+    automatic: "automatic";
+}>;
+export declare const creditNoteStatusSchema: z.ZodEnum<{
+    draft: "draft";
+    issued: "issued";
+    applied: "applied";
+}>;
+export declare const paymentScheduleTypeSchema: z.ZodEnum<{
+    other: "other";
+    deposit: "deposit";
+    installment: "installment";
+    balance: "balance";
+    hold: "hold";
+}>;
+export declare const paymentScheduleStatusSchema: z.ZodEnum<{
+    expired: "expired";
+    cancelled: "cancelled";
+    pending: "pending";
+    paid: "paid";
+    due: "due";
+    waived: "waived";
+}>;
+export declare const guaranteeTypeSchema: z.ZodEnum<{
+    other: "other";
+    voucher: "voucher";
+    bank_transfer: "bank_transfer";
+    credit_card: "credit_card";
+    deposit: "deposit";
+    preauth: "preauth";
+    card_on_file: "card_on_file";
+    agency_letter: "agency_letter";
+}>;
+export declare const guaranteeStatusSchema: z.ZodEnum<{
+    expired: "expired";
+    cancelled: "cancelled";
+    pending: "pending";
+    released: "released";
+    failed: "failed";
+    active: "active";
+}>;
+export declare const taxScopeSchema: z.ZodEnum<{
+    included: "included";
+    excluded: "excluded";
+    withheld: "withheld";
+}>;
+export declare const commissionRecipientTypeSchema: z.ZodEnum<{
+    internal: "internal";
+    supplier: "supplier";
+    other: "other";
+    affiliate: "affiliate";
+    channel: "channel";
+    agency: "agency";
+    agent: "agent";
+}>;
+export declare const commissionModelSchema: z.ZodEnum<{
+    fixed: "fixed";
+    percentage: "percentage";
+    markup: "markup";
+    net: "net";
+}>;
+export declare const commissionStatusSchema: z.ZodEnum<{
+    pending: "pending";
+    paid: "paid";
+    void: "void";
+    accrued: "accrued";
+    payable: "payable";
+}>;
+export declare const paginationSchema: z.ZodObject<{
+    limit: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+    offset: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+}, z.core.$strip>;
+//# sourceMappingURL=validation-shared.d.ts.map

package/dist/validation-shared.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation-shared.d.ts","sourceRoot":"","sources":["../src/validation-shared.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,eAAO,MAAM,mBAAmB;;;;;;;EAO9B,CAAA;AACF,eAAO,MAAM,mBAAmB;;;;;;;;;;EAU9B,CAAA;AACF,eAAO,MAAM,mBAAmB;;;;;EAAyD,CAAA;AACzF,eAAO,MAAM,0BAA0B;;;;;;;;;EASrC,CAAA;AACF,eAAO,MAAM,8BAA8B;;;;;;;EAOzC,CAAA;AACF,eAAO,MAAM,2BAA2B;;;;;;;;;EAStC,CAAA;AACF,eAAO,MAAM,gCAAgC;;;;;;;EAO3C,CAAA;AACF,eAAO,MAAM,6BAA6B;;;;;;EAMxC,CAAA;AACF,eAAO,MAAM,gCAAgC;;;;;;;;EAQ3C,CAAA;AACF,eAAO,MAAM,0BAA0B;;;;;;EAMrC,CAAA;AACF,eAAO,MAAM,iBAAiB;;;EAAkC,CAAA;AAChE,eAAO,MAAM,sBAAsB;;;;EAAyC,CAAA;AAC5E,eAAO,MAAM,yBAAyB;;;;;;EAMpC,CAAA;AACF,eAAO,MAAM,2BAA2B;;;;;;;EAOtC,CAAA;AACF,eAAO,MAAM,mBAAmB;;;;;;;;;EAS9B,CAAA;AACF,eAAO,MAAM,qBAAqB;;;;;;;EAOhC,CAAA;AACF,eAAO,MAAM,cAAc;;;;EAA+C,CAAA;AAC1E,eAAO,MAAM,6BAA6B;;;;;;;;EAQxC,CAAA;AACF,eAAO,MAAM,qBAAqB;;;;;EAAmD,CAAA;AACrF,eAAO,MAAM,sBAAsB;;;;;;EAA4D,CAAA;AAE/F,eAAO,MAAM,gBAAgB;;;iBAG3B,CAAA"}

package/dist/validation-shared.js

@@ -0,0 +1,131 @@
+import { z } from "zod";
+export const invoiceStatusSchema = z.enum([
+    "draft",
+    "sent",
+    "partially_paid",
+    "paid",
+    "overdue",
+    "void",
+]);
+export const paymentMethodSchema = z.enum([
+    "bank_transfer",
+    "credit_card",
+    "debit_card",
+    "cash",
+    "cheque",
+    "wallet",
+    "direct_bill",
+    "voucher",
+    "other",
+]);
+export const paymentStatusSchema = z.enum(["pending", "completed", "failed", "refunded"]);
+export const paymentSessionStatusSchema = z.enum([
+    "pending",
+    "requires_redirect",
+    "processing",
+    "authorized",
+    "paid",
+    "failed",
+    "cancelled",
+    "expired",
+]);
+export const paymentSessionTargetTypeSchema = z.enum([
+    "booking",
+    "order",
+    "invoice",
+    "booking_payment_schedule",
+    "booking_guarantee",
+    "other",
+]);
+export const paymentInstrumentTypeSchema = z.enum([
+    "credit_card",
+    "debit_card",
+    "bank_account",
+    "wallet",
+    "voucher",
+    "direct_bill",
+    "cash",
+    "other",
+]);
+export const paymentInstrumentOwnerTypeSchema = z.enum([
+    "client",
+    "supplier",
+    "channel",
+    "agency",
+    "internal",
+    "other",
+]);
+export const paymentInstrumentStatusSchema = z.enum([
+    "active",
+    "inactive",
+    "expired",
+    "revoked",
+    "failed_verification",
+]);
+export const paymentAuthorizationStatusSchema = z.enum([
+    "pending",
+    "authorized",
+    "partially_captured",
+    "captured",
+    "voided",
+    "failed",
+    "expired",
+]);
+export const paymentCaptureStatusSchema = z.enum([
+    "pending",
+    "completed",
+    "failed",
+    "refunded",
+    "voided",
+]);
+export const captureModeSchema = z.enum(["automatic", "manual"]);
+export const creditNoteStatusSchema = z.enum(["draft", "issued", "applied"]);
+export const paymentScheduleTypeSchema = z.enum([
+    "deposit",
+    "installment",
+    "balance",
+    "hold",
+    "other",
+]);
+export const paymentScheduleStatusSchema = z.enum([
+    "pending",
+    "due",
+    "paid",
+    "waived",
+    "cancelled",
+    "expired",
+]);
+export const guaranteeTypeSchema = z.enum([
+    "deposit",
+    "credit_card",
+    "preauth",
+    "card_on_file",
+    "bank_transfer",
+    "voucher",
+    "agency_letter",
+    "other",
+]);
+export const guaranteeStatusSchema = z.enum([
+    "pending",
+    "active",
+    "released",
+    "failed",
+    "cancelled",
+    "expired",
+]);
+export const taxScopeSchema = z.enum(["included", "excluded", "withheld"]);
+export const commissionRecipientTypeSchema = z.enum([
+    "channel",
+    "affiliate",
+    "agency",
+    "agent",
+    "internal",
+    "supplier",
+    "other",
+]);
+export const commissionModelSchema = z.enum(["percentage", "fixed", "markup", "net"]);
+export const commissionStatusSchema = z.enum(["pending", "accrued", "payable", "paid", "void"]);
+export const paginationSchema = z.object({
+    limit: z.coerce.number().int().min(1).max(100).default(50),
+    offset: z.coerce.number().int().min(0).default(0),
+});