@voyant-travel/finance 0.151.3 → 0.152.0

package/dist/runtime.js

@@ -0,0 +1,98 @@
+import { createVoyantDataFxExchangeRateResolver, } from "./invoice-fx.js";
+/** Compose Finance's main HTTP runtime from generic host and selected providers. */
+export function createFinanceRuntime(host, notifications, checkoutPaymentStarters, invoiceSettlementPollerProviders = []) {
+    const { primitives } = host;
+    return {
+        resolveDocumentDownloadUrl: primitives.storage.downloadUrl,
+        resolveInvoiceExchangeRateResolver: (bindings) => createExchangeRateResolver(primitives, bindings),
+        invoiceSettlementPollers: aggregateFinanceInvoiceSettlementPollers(invoiceSettlementPollerProviders),
+        invoiceDueDateResolver: ({ issueDate, dueDate, bookingPaymentSchedule }) => bookingPaymentSchedule && dueDate < issueDate ? issueDate : dueDate,
+        resolveNotificationDispatcher: notifications.resolveNotificationDispatcher,
+        resolvePaymentStarters: (bindings) => checkoutPaymentStarters?.resolvePaymentStarters(bindings) ?? {},
+        resolveBankTransferDetails: (bindings) => resolveBankTransferDetails(primitives.env(bindings)),
+        resolvePublicCheckoutBaseUrl: (bindings) => resolvePublicCheckoutBaseUrl(primitives.env(bindings)),
+        listBookingReminderRuns: notifications.listBookingReminderRuns,
+    };
+}
+/** Compose Finance's payment schedule from statically selected domain providers. */
+export function createFinanceBookingScheduleRuntime(host, settings, distribution, accommodations, cruises, inventory) {
+    const paymentPolicy = inventory.createPaymentPolicyRuntime({
+        resolveSupplierPolicy: distribution.resolveSupplierPolicy,
+        resolveSupplierPolicyById: distribution.resolveSupplierPolicyById,
+        resolveVerticalListingPolicy: async (db, bookingId) => (await cruises.resolveBookingPolicy(db, bookingId)) ??
+            accommodations.resolveBookingPolicy(db, bookingId),
+        resolveVerticalListingPolicyForEntity: async (db, context) => (await cruises.resolveEntityPolicy(db, context)) ??
+            accommodations.resolveEntityPolicy(db, context),
+        resolveVerticalSupplierPolicyForEntity: async (db, context) => {
+            const supplierId = await cruises.resolveSupplierId(db, context);
+            return supplierId ? distribution.resolveSupplierPolicyById(db, supplierId) : null;
+        },
+    });
+    return {
+        options: {
+            resolveDb: (context) => host.primitives.database.fromContext(context),
+            resolveOperatorDefaultPaymentPolicy: settings.resolveOperatorDefaultPaymentPolicy,
+            ...paymentPolicy,
+            stampPolicySourceOnBooking: inventory.stampPolicySourceOnBooking,
+            readPolicySourceFromInternalNotes: inventory.readPolicySourceFromInternalNotes,
+        },
+        withDb: (bindings, operation) => host.primitives.database.transaction(bindings, (database) => operation(database)),
+    };
+}
+export function createFinanceBookingTaxRuntime(settings) {
+    return {
+        resolveBookingTaxSettings: settings.resolveBookingTaxSettings,
+        updateBookingTaxSettings: settings.updateBookingTaxSettings,
+    };
+}
+function createExchangeRateResolver(primitives, bindings) {
+    const env = primitives.env(bindings);
+    const apiKey = nonEmpty(env.VOYANT_DATA_API_KEY) ??
+        (env.VOYANT_ADMIN_AUTH_MODE === "voyant-cloud"
+            ? (nonEmpty(env.VOYANT_API_KEY) ?? nonEmpty(env.VOYANT_CLOUD_API_KEY))
+            : undefined);
+    if (!apiKey)
+        return undefined;
+    return createVoyantDataFxExchangeRateResolver({
+        apiKey,
+        baseUrl: nonEmpty(env.VOYANT_CLOUD_API_URL),
+    });
+}
+export function aggregateFinanceInvoiceSettlementPollers(providers) {
+    const pollers = {};
+    for (const provider of [...providers].sort((left, right) => left.provider < right.provider ? -1 : left.provider > right.provider ? 1 : 0)) {
+        if (Object.hasOwn(pollers, provider.provider)) {
+            throw new Error(`Finance invoice settlement poller provider "${provider.provider}" was selected more than once.`);
+        }
+        pollers[provider.provider] = provider.poller;
+    }
+    return Object.freeze(pollers);
+}
+function resolveBankTransferDetails(env) {
+    const beneficiary = stringValue(env.BANK_TRANSFER_BENEFICIARY);
+    const iban = stringValue(env.BANK_TRANSFER_IBAN);
+    if (!beneficiary || !iban)
+        return null;
+    return {
+        provider: "bank-transfer",
+        beneficiary,
+        iban,
+        bankName: stringValue(env.BANK_TRANSFER_BANK_NAME) ?? null,
+        notes: stringValue(env.BANK_TRANSFER_NOTES) ?? null,
+    };
+}
+function resolvePublicCheckoutBaseUrl(env) {
+    return (nonEmpty(env.PUBLIC_CHECKOUT_BASE_URL) ??
+        nonEmpty(env.DASH_BASE_URL) ??
+        nonEmpty(env.APP_URL)?.replace(/\/api\/?$/, "") ??
+        null);
+}
+function nonEmpty(value) {
+    if (typeof value !== "string")
+        return undefined;
+    const trimmed = value.trim();
+    return trimmed || undefined;
+}
+function stringValue(value) {
+    return typeof value === "string" ? value : undefined;
+}

package/dist/stale-booking-holds-runtime.d.ts

@@ -0,0 +1,9 @@
+import type { BookingsExpireStaleHoldsWorkflowRuntime } from "@voyant-travel/bookings/workflow-runtime";
+import type { PostgresJsDatabase } from "drizzle-orm/postgres-js";
+export interface FinanceStaleBookingHoldsRuntimeOptions {
+    resolveDb: () => PostgresJsDatabase | Promise<PostgresJsDatabase>;
+    userId?: string;
+}
+/** Finance-owned effects required when Bookings expires stale holds. */
+export declare function createFinanceStaleBookingHoldsRuntime(options: FinanceStaleBookingHoldsRuntimeOptions): BookingsExpireStaleHoldsWorkflowRuntime;
+//# sourceMappingURL=stale-booking-holds-runtime.d.ts.map

package/dist/stale-booking-holds-runtime.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stale-booking-holds-runtime.d.ts","sourceRoot":"","sources":["../src/stale-booking-holds-runtime.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,uCAAuC,EAAE,MAAM,0CAA0C,CAAA;AAEvG,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAA;AAKjE,MAAM,WAAW,sCAAsC;IACrD,SAAS,EAAE,MAAM,kBAAkB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAA;IACjE,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,wEAAwE;AACxE,wBAAgB,qCAAqC,CACnD,OAAO,EAAE,sCAAsC,GAC9C,uCAAuC,CAyBzC"}

package/dist/stale-booking-holds-runtime.js

@@ -0,0 +1,25 @@
+import { and, eq, inArray } from "drizzle-orm";
+import { closeTerminalBookingPaymentSchedules } from "./booking-lifecycle.js";
+import { paymentSessions } from "./schema.js";
+import { financeService } from "./service.js";
+/** Finance-owned effects required when Bookings expires stale holds. */
+export function createFinanceStaleBookingHoldsRuntime(options) {
+    return {
+        resolveDb: options.resolveDb,
+        resolveRuntime: () => ({
+            expirePaymentSessionsForBooking: async (db, bookingId) => {
+                const staleSessions = await db
+                    .select({ id: paymentSessions.id })
+                    .from(paymentSessions)
+                    .where(and(eq(paymentSessions.bookingId, bookingId), inArray(paymentSessions.status, ["pending", "requires_redirect", "processing"])));
+                for (const session of staleSessions) {
+                    await financeService.expirePaymentSession(db, session.id, {
+                        notes: "Booking hold expired",
+                    });
+                }
+            },
+            closePaymentSchedulesForBooking: closeTerminalBookingPaymentSchedules,
+        }),
+        userId: options.userId,
+    };
+}

package/dist/voyant.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"voyant.d.ts","sourceRoot":"","sources":["../src/voyant.ts"],"names":[],"mappings":"AAOA,wEAAwE;AACxE,eAAO,MAAM,mBAAmB,uDA+K9B,CAAA;AAEF,eAAO,MAAM,6BAA6B,uDAmBxC,CAAA;AAEF,eAAO,MAAM,iCAAiC,uDAmB5C,CAAA;AAEF,eAAO,MAAM,kCAAkC,uDA6B7C,CAAA;AAEF,eAAe,mBAAmB,CAAA"}
+{"version":3,"file":"voyant.d.ts","sourceRoot":"","sources":["../src/voyant.ts"],"names":[],"mappings":"AAkBA,wEAAwE;AACxE,eAAO,MAAM,mBAAmB,uDAsS9B,CAAA;AAEF,eAAO,MAAM,6BAA6B,uDAsBxC,CAAA;AAEF,eAAO,MAAM,iCAAiC,uDAoB5C,CAAA;AAEF,eAAO,MAAM,kCAAkC,uDAsD7C,CAAA;AAEF,eAAe,mBAAmB,CAAA"}

package/dist/voyant.js

@@ -1,4 +1,5 @@
-import { defineExtension, defineModule } from "@voyant-travel/core/project";
+import { defineExtension, defineModule, requirePort } from "@voyant-travel/core/project";
+import { financeAccommodationsPaymentPolicyRuntimePort, financeCheckoutPaymentStartersRuntimePort, financeCruisesPaymentPolicyRuntimePort, financeDistributionPaymentPolicyRuntimePort, financeHostRuntimePort, financeInventoryPaymentPolicyRuntimePort, financeInvoiceSettlementPollerRuntimePort, financeNotificationsRuntimePort, financeOperatorSettingsRuntimePort, } from "./runtime-port.js";
 const financeAdminRuntime = {
     entry: "@voyant-travel/finance-react/admin",
     export: "createFinanceAdminExtension",
@@ -8,11 +9,23 @@ export const financeVoyantModule = defineModule({
     id: "@voyant-travel/finance",
     packageName: "@voyant-travel/finance",
     localId: "finance",
+    runtime: { entry: "@voyant-travel/finance", export: "createFinanceVoyantRuntime" },
+    runtimePorts: [
+        requirePort(financeHostRuntimePort),
+        requirePort(financeNotificationsRuntimePort),
+        requirePort(financeCheckoutPaymentStartersRuntimePort, { optional: true }),
+        requirePort(financeInvoiceSettlementPollerRuntimePort, {
+            optional: true,
+            cardinality: "many",
+        }),
+    ],
+    provides: { capabilities: ["finance.payment-sessions"] },
     api: [
         {
             id: "@voyant-travel/finance#api.admin",
             surface: "admin",
             mount: "finance",
+            openapi: { document: "finance" },
             transactional: true,
             runtime: {
                 entry: "@voyant-travel/finance",
@@ -23,6 +36,7 @@ export const financeVoyantModule = defineModule({
             id: "@voyant-travel/finance#api.public",
             surface: "public",
             mount: "finance",
+            openapi: { document: "finance" },
             anonymous: ["/bookings", "/collections", "/payment-sessions", "/accountant", "/vouchers"],
             transactional: true,
             runtime: {
@@ -62,44 +76,125 @@ export const financeVoyantModule = defineModule({
         },
     ],
     events: [
-        { id: "@voyant-travel/finance#event.invoice.issued", eventType: "invoice.issued" },
+        {
+            id: "@voyant-travel/finance#event.invoice.issued",
+            eventType: "invoice.issued",
+            version: "1.0.0",
+            payloadSchema: { type: "object", additionalProperties: true },
+            visibility: "internal",
+            audit: { sourceModule: "finance", category: "domain" },
+        },
         {
             id: "@voyant-travel/finance#event.invoice.proforma.issued",
             eventType: "invoice.proforma.issued",
+            version: "1.0.0",
+            payloadSchema: { type: "object", additionalProperties: true },
+            visibility: "internal",
+            audit: { sourceModule: "finance", category: "domain" },
         },
         {
             id: "@voyant-travel/finance#event.invoice.proforma.converted",
             eventType: "invoice.proforma.converted",
+            version: "1.0.0",
+            payloadSchema: { type: "object", additionalProperties: true },
+            visibility: "internal",
+            audit: { sourceModule: "finance", category: "domain" },
+        },
+        {
+            id: "@voyant-travel/finance#event.invoice.voided",
+            eventType: "invoice.voided",
+            version: "1.0.0",
+            payloadSchema: { type: "object", additionalProperties: true },
+            visibility: "internal",
+            audit: { sourceModule: "finance", category: "domain" },
+        },
+        {
+            id: "@voyant-travel/finance#event.invoice.settled",
+            eventType: "invoice.settled",
+            version: "1.0.0",
+            payloadSchema: { type: "object", additionalProperties: true },
+            visibility: "internal",
+            audit: { sourceModule: "finance", category: "domain" },
+        },
+        {
+            id: "@voyant-travel/finance#event.invoice.rendered",
+            eventType: "invoice.rendered",
+            version: "1.0.0",
+            payloadSchema: { type: "object", additionalProperties: true },
+            visibility: "internal",
+            audit: { sourceModule: "finance", category: "domain" },
         },
-        { id: "@voyant-travel/finance#event.invoice.voided", eventType: "invoice.voided" },
-        { id: "@voyant-travel/finance#event.invoice.settled", eventType: "invoice.settled" },
-        { id: "@voyant-travel/finance#event.invoice.rendered", eventType: "invoice.rendered" },
         {
             id: "@voyant-travel/finance#event.invoice.document.generated",
             eventType: "invoice.document.generated",
+            version: "1.0.0",
+            payloadSchema: { type: "object", additionalProperties: true },
+            visibility: "internal",
+            audit: { sourceModule: "finance", category: "domain" },
         },
         {
             id: "@voyant-travel/finance#event.invoice.payment.recorded",
             eventType: "invoice.payment.recorded",
+            version: "1.0.0",
+            payloadSchema: { type: "object", additionalProperties: true },
+            visibility: "internal",
+            audit: { sourceModule: "finance", category: "domain" },
+        },
+        {
+            id: "@voyant-travel/finance#event.payment.completed",
+            eventType: "payment.completed",
+            version: "1.0.0",
+            payloadSchema: { type: "object", additionalProperties: true },
+            visibility: "internal",
+            audit: { sourceModule: "finance", category: "domain" },
+        },
+        {
+            id: "@voyant-travel/finance#event.booking.created",
+            eventType: "booking.created",
+            version: "1.0.0",
+            payloadSchema: { type: "object", additionalProperties: true },
+            visibility: "internal",
+            audit: { sourceModule: "finance", category: "domain" },
+        },
+        {
+            id: "@voyant-travel/finance#event.booking.confirmed",
+            eventType: "booking.confirmed",
+            version: "1.0.0",
+            payloadSchema: { type: "object", additionalProperties: true },
+            visibility: "internal",
+            audit: { sourceModule: "finance", category: "domain" },
         },
-        { id: "@voyant-travel/finance#event.payment.completed", eventType: "payment.completed" },
-        { id: "@voyant-travel/finance#event.booking.created", eventType: "booking.created" },
-        { id: "@voyant-travel/finance#event.booking.confirmed", eventType: "booking.confirmed" },
         {
             id: "@voyant-travel/finance#event.booking.dual-created",
             eventType: "booking.dual-created",
+            version: "1.0.0",
+            payloadSchema: { type: "object", additionalProperties: true },
+            visibility: "internal",
+            audit: { sourceModule: "finance", category: "domain" },
         },
         {
             id: "@voyant-travel/finance#event.booking-create.rejected",
             eventType: "booking_create.rejected",
+            version: "1.0.0",
+            payloadSchema: { type: "object", additionalProperties: true },
+            visibility: "internal",
+            audit: { sourceModule: "finance", category: "domain" },
         },
         {
             id: "@voyant-travel/finance#event.booking.contract-document.requested",
             eventType: "booking.contract_document.requested",
+            version: "1.0.0",
+            payloadSchema: { type: "object", additionalProperties: true },
+            visibility: "internal",
+            audit: { sourceModule: "finance", category: "domain" },
         },
         {
             id: "@voyant-travel/finance#event.booking-payment-schedule.paid",
             eventType: "booking_payment_schedule.paid",
+            version: "1.0.0",
+            payloadSchema: { type: "object", additionalProperties: true },
+            visibility: "internal",
+            audit: { sourceModule: "finance", category: "domain" },
         },
     ],
     setupMigrations: [
@@ -120,6 +215,11 @@ export const financeVoyantModule = defineModule({
                 resource: "finance",
                 actions: ["read", "write", "refund", "void"],
             },
+            {
+                id: "@voyant-travel/finance#access.transactions",
+                resource: "transactions",
+                actions: ["read", "write"],
+            },
         ],
     },
     tools: [
@@ -128,21 +228,40 @@ export const financeVoyantModule = defineModule({
             name: "list_invoices",
             runtime: { entry: "@voyant-travel/finance/tools", export: "listInvoicesTool" },
             requiredScopes: ["finance:read"],
+            context: ["finance"],
         },
         {
             id: "@voyant-travel/finance#tool.get-invoice",
             name: "get_invoice",
             runtime: { entry: "@voyant-travel/finance/tools", export: "getInvoiceTool" },
             requiredScopes: ["finance:read"],
+            context: ["finance"],
         },
         {
             id: "@voyant-travel/finance#tool.void-invoice",
             name: "void_invoice",
             runtime: { entry: "@voyant-travel/finance/tools", export: "voidInvoiceTool" },
             requiredScopes: ["finance:void"],
+            context: ["finance"],
         },
     ],
     admin: {
+        compositionOrder: 40,
+        runtime: {
+            entry: "@voyant-travel/finance-react/admin",
+            export: "createSelectedFinanceAdminExtension",
+        },
+        copy: [
+            {
+                id: "@voyant-travel/finance#admin.copy",
+                namespace: "finance.admin",
+                fallbackLocale: "en",
+                runtime: {
+                    entry: "@voyant-travel/finance-react/i18n",
+                    export: "financeUiMessageDefinitions",
+                },
+            },
+        ],
         routes: [
             ["index", "/finance"],
             ["invoices-index", "/finance/invoices"],
@@ -159,6 +278,7 @@ export const financeVoyantModule = defineModule({
             runtime: financeAdminRuntime,
         })),
         contributions: [
+            ["booking-payment-controller", "booking.details.payment-controller"],
             ["booking-invoices", "booking.details.invoices-tab"],
             ["booking-pending-payment-sessions", "booking.details.finance-start"],
             ["booking-payment-policy", "booking.details.finance-end"],
@@ -180,11 +300,14 @@ export const financeBookingTaxVoyantPlugin = defineExtension({
     id: "@voyant-travel/finance#booking-tax-extension",
     packageName: "@voyant-travel/finance",
     localId: "finance.booking-tax-extension",
+    runtime: { entry: "@voyant-travel/finance", export: "createBookingTaxVoyantRuntime" },
+    runtimePorts: [requirePort(financeOperatorSettingsRuntimePort)],
     api: [
         {
             id: "@voyant-travel/finance#booking-tax-extension.api",
             surface: "admin",
             mount: "bookings",
+            openapi: { document: "booking-tax" },
             transactional: true,
             runtime: {
                 entry: "@voyant-travel/finance",
@@ -205,6 +328,7 @@ export const financeBookingsCreateVoyantPlugin = defineExtension({
             id: "@voyant-travel/finance#bookings-create-extension.api",
             surface: "admin",
             mount: "bookings",
+            openapi: { document: "bookings" },
             transactional: true,
             runtime: {
                 entry: "@voyant-travel/finance",
@@ -220,11 +344,24 @@ export const financeBookingScheduleVoyantPlugin = defineExtension({
     id: "@voyant-travel/finance#booking-schedule-extension",
     packageName: "@voyant-travel/finance",
     localId: "finance.booking-schedule-extension",
+    runtime: {
+        entry: "@voyant-travel/finance",
+        export: "createBookingScheduleVoyantRuntime",
+    },
+    runtimePorts: [
+        requirePort(financeHostRuntimePort),
+        requirePort(financeOperatorSettingsRuntimePort),
+        requirePort(financeDistributionPaymentPolicyRuntimePort),
+        requirePort(financeAccommodationsPaymentPolicyRuntimePort),
+        requirePort(financeCruisesPaymentPolicyRuntimePort),
+        requirePort(financeInventoryPaymentPolicyRuntimePort),
+    ],
     api: [
         {
             id: "@voyant-travel/finance#booking-schedule-extension.api.admin",
             surface: "admin",
             mount: "bookings",
+            openapi: { document: "bookings" },
             transactional: true,
             runtime: {
                 entry: "@voyant-travel/finance",
@@ -235,6 +372,7 @@ export const financeBookingScheduleVoyantPlugin = defineExtension({
             id: "@voyant-travel/finance#booking-schedule-extension.api.public",
             surface: "public",
             mount: "payment-policy",
+            openapi: { document: "bookings" },
             anonymous: true,
             runtime: {
                 entry: "@voyant-travel/finance",
@@ -242,6 +380,17 @@ export const financeBookingScheduleVoyantPlugin = defineExtension({
             },
         },
     ],
+    subscribers: [
+        {
+            id: "@voyant-travel/finance#subscriber.booking-schedule-confirmed",
+            eventType: "booking.confirmed",
+            source: "@voyant-travel/finance/booking-schedule-subscriber",
+            runtime: {
+                entry: "./booking-schedule-subscriber",
+                export: "bookingScheduleConfirmedSubscriber",
+            },
+        },
+    ],
     meta: {
         ownership: "package",
     },

package/openapi/admin/booking-tax.json

@@ -0,0 +1,86 @@
+{
+  "openapi": "3.1.0",
+  "info": {
+    "title": "Booking Tax API",
+    "version": "1.0.0"
+  },
+  "paths": {
+    "/v1/admin/bookings/tax-settings": {
+      "get": {
+        "summary": "Get booking tax settings",
+        "x-voyant-api-id": "@voyant-travel/finance#booking-tax-extension.api",
+        "responses": {
+          "200": {
+            "description": "The effective booking tax settings",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "required": ["data"],
+                  "properties": { "data": { "$ref": "#/components/schemas/BookingTaxSettings" } }
+                }
+              }
+            }
+          }
+        }
+      },
+      "patch": {
+        "summary": "Update booking tax settings",
+        "x-voyant-api-id": "@voyant-travel/finance#booking-tax-extension.api",
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "taxPriceMode": { "type": "string", "enum": ["inclusive", "exclusive"] },
+                  "taxPolicyProfileId": { "type": ["string", "null"] }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": { "description": "The updated booking tax settings" },
+          "409": { "description": "This deployment does not support tax setting updates" }
+        }
+      }
+    },
+    "/v1/admin/bookings/tax-preview": {
+      "post": {
+        "summary": "Preview tax for a booking item subtotal",
+        "x-voyant-api-id": "@voyant-travel/finance#booking-tax-extension.api",
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "required": ["productId", "subtotalCents", "currency"],
+                "properties": {
+                  "productId": { "type": "string", "minLength": 1 },
+                  "subtotalCents": { "type": "integer", "minimum": 0 },
+                  "currency": { "type": "string", "minLength": 3, "maxLength": 8 }
+                }
+              }
+            }
+          }
+        },
+        "responses": { "200": { "description": "The calculated tax preview" } }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "BookingTaxSettings": {
+        "type": "object",
+        "required": ["taxPriceMode", "taxPolicyProfileId"],
+        "properties": {
+          "taxPriceMode": { "type": "string", "enum": ["inclusive", "exclusive"] },
+          "taxPolicyProfileId": { "type": ["string", "null"] }
+        }
+      }
+    }
+  }
+}