@voyant-travel/finance 0.167.0 → 0.168.0

package/dist/routes-vouchers.d.ts

@@ -0,0 +1,401 @@
+/**
+ * Admin voucher routes — mounted by the operator starter under
+ * `/v1/admin/finance/...`. Covers voucher issuance, lookup, update, and
+ * redemption.
+ *
+ * Migrated to `@hono/zod-openapi` for the OpenAPI admin backfill (voyant#2114 /
+ * voyant#2208 — finance sub-batch 9C). Request schemas reuse the existing
+ * `@voyant-travel/finance-contracts` schemas the handlers already parse;
+ * response schemas come from the shared `routes-payment-schemas.ts` row shapes
+ * (authored from the Drizzle `$inferSelect` shapes; §17 dates → strings). The
+ * single voucher resource is its own `OpenAPIHono` sub-chain composed onto
+ * `financeVoucherRoutes` via `.route("/")` so the `.openapi()` operations
+ * propagate up through the parent `financeRoutes` registry.
+ */
+import { OpenAPIHono } from "@hono/zod-openapi";
+import type { Env } from "./routes-shared.js";
+export declare const financeVoucherRoutes: OpenAPIHono<Env, import("hono/types").MergeSchemaPath<{
+    "/vouchers": {
+        $get: {
+            input: {
+                query: {
+                    status?: "void" | "expired" | "active" | "redeemed" | undefined;
+                    seriesCode?: string | undefined;
+                    issuedToPersonId?: string | undefined;
+                    issuedToOrganizationId?: string | undefined;
+                    search?: string | undefined;
+                    hasBalance?: unknown;
+                    limit?: unknown;
+                    offset?: unknown;
+                };
+            };
+            output: {
+                data: {
+                    id: string;
+                    code: string;
+                    seriesCode: string | null;
+                    status: "void" | "expired" | "active" | "redeemed";
+                    currency: string;
+                    initialAmountCents: number;
+                    remainingAmountCents: number;
+                    issuedToPersonId: string | null;
+                    issuedToOrganizationId: string | null;
+                    sourceType: "manual" | "refund" | "cancellation_credit" | "gift" | "promo";
+                    sourceBookingId: string | null;
+                    sourcePaymentId: string | null;
+                    validFrom: string | null;
+                    expiresAt: string | null;
+                    notes: string | null;
+                    issuedByUserId: string | null;
+                    createdAt: string;
+                    updatedAt: string;
+                }[];
+                total: number;
+                limit: number;
+                offset: number;
+            };
+            outputFormat: "json";
+            status: 200;
+        };
+    };
+} & {
+    "/vouchers": {
+        $post: {
+            input: {
+                json: {
+                    currency: string;
+                    amountCents: number;
+                    sourceType: "manual" | "refund" | "cancellation_credit" | "gift" | "promo";
+                    code?: string | null | undefined;
+                    seriesCode?: string | null | undefined;
+                    issuedToPersonId?: string | null | undefined;
+                    issuedToOrganizationId?: string | null | undefined;
+                    sourceBookingId?: string | null | undefined;
+                    sourcePaymentId?: string | null | undefined;
+                    validFrom?: string | null | undefined;
+                    expiresAt?: string | null | undefined;
+                    notes?: string | null | undefined;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 400;
+        } | {
+            input: {
+                json: {
+                    currency: string;
+                    amountCents: number;
+                    sourceType: "manual" | "refund" | "cancellation_credit" | "gift" | "promo";
+                    code?: string | null | undefined;
+                    seriesCode?: string | null | undefined;
+                    issuedToPersonId?: string | null | undefined;
+                    issuedToOrganizationId?: string | null | undefined;
+                    sourceBookingId?: string | null | undefined;
+                    sourcePaymentId?: string | null | undefined;
+                    validFrom?: string | null | undefined;
+                    expiresAt?: string | null | undefined;
+                    notes?: string | null | undefined;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 409;
+        } | {
+            input: {
+                json: {
+                    currency: string;
+                    amountCents: number;
+                    sourceType: "manual" | "refund" | "cancellation_credit" | "gift" | "promo";
+                    code?: string | null | undefined;
+                    seriesCode?: string | null | undefined;
+                    issuedToPersonId?: string | null | undefined;
+                    issuedToOrganizationId?: string | null | undefined;
+                    sourceBookingId?: string | null | undefined;
+                    sourcePaymentId?: string | null | undefined;
+                    validFrom?: string | null | undefined;
+                    expiresAt?: string | null | undefined;
+                    notes?: string | null | undefined;
+                };
+            };
+            output: {
+                data: {
+                    id: string;
+                    code: string;
+                    seriesCode: string | null;
+                    status: "void" | "expired" | "active" | "redeemed";
+                    currency: string;
+                    initialAmountCents: number;
+                    remainingAmountCents: number;
+                    issuedToPersonId: string | null;
+                    issuedToOrganizationId: string | null;
+                    sourceType: "manual" | "refund" | "cancellation_credit" | "gift" | "promo";
+                    sourceBookingId: string | null;
+                    sourcePaymentId: string | null;
+                    validFrom: string | null;
+                    expiresAt: string | null;
+                    notes: string | null;
+                    issuedByUserId: string | null;
+                    createdAt: string;
+                    updatedAt: string;
+                };
+            };
+            outputFormat: "json";
+            status: 201;
+        };
+    };
+} & {
+    "/vouchers/:id": {
+        $get: {
+            input: {
+                param: {
+                    id: string;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 404;
+        } | {
+            input: {
+                param: {
+                    id: string;
+                };
+            };
+            output: {
+                data: {
+                    id: string;
+                    code: string;
+                    seriesCode: string | null;
+                    status: "void" | "expired" | "active" | "redeemed";
+                    currency: string;
+                    initialAmountCents: number;
+                    remainingAmountCents: number;
+                    issuedToPersonId: string | null;
+                    issuedToOrganizationId: string | null;
+                    sourceType: "manual" | "refund" | "cancellation_credit" | "gift" | "promo";
+                    sourceBookingId: string | null;
+                    sourcePaymentId: string | null;
+                    validFrom: string | null;
+                    expiresAt: string | null;
+                    notes: string | null;
+                    issuedByUserId: string | null;
+                    createdAt: string;
+                    updatedAt: string;
+                };
+            };
+            outputFormat: "json";
+            status: 200;
+        };
+    };
+} & {
+    "/vouchers/:id": {
+        $patch: {
+            input: {
+                param: {
+                    id: string;
+                };
+            } & {
+                json: {
+                    status?: "void" | "expired" | "active" | "redeemed" | undefined;
+                    seriesCode?: string | null | undefined;
+                    validFrom?: string | null | undefined;
+                    expiresAt?: string | null | undefined;
+                    notes?: string | null | undefined;
+                    issuedToPersonId?: string | null | undefined;
+                    issuedToOrganizationId?: string | null | undefined;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 404;
+        } | {
+            input: {
+                param: {
+                    id: string;
+                };
+            } & {
+                json: {
+                    status?: "void" | "expired" | "active" | "redeemed" | undefined;
+                    seriesCode?: string | null | undefined;
+                    validFrom?: string | null | undefined;
+                    expiresAt?: string | null | undefined;
+                    notes?: string | null | undefined;
+                    issuedToPersonId?: string | null | undefined;
+                    issuedToOrganizationId?: string | null | undefined;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 400;
+        } | {
+            input: {
+                param: {
+                    id: string;
+                };
+            } & {
+                json: {
+                    status?: "void" | "expired" | "active" | "redeemed" | undefined;
+                    seriesCode?: string | null | undefined;
+                    validFrom?: string | null | undefined;
+                    expiresAt?: string | null | undefined;
+                    notes?: string | null | undefined;
+                    issuedToPersonId?: string | null | undefined;
+                    issuedToOrganizationId?: string | null | undefined;
+                };
+            };
+            output: {
+                data: {
+                    id: string;
+                    code: string;
+                    seriesCode: string | null;
+                    status: "void" | "expired" | "active" | "redeemed";
+                    currency: string;
+                    initialAmountCents: number;
+                    remainingAmountCents: number;
+                    issuedToPersonId: string | null;
+                    issuedToOrganizationId: string | null;
+                    sourceType: "manual" | "refund" | "cancellation_credit" | "gift" | "promo";
+                    sourceBookingId: string | null;
+                    sourcePaymentId: string | null;
+                    validFrom: string | null;
+                    expiresAt: string | null;
+                    notes: string | null;
+                    issuedByUserId: string | null;
+                    createdAt: string;
+                    updatedAt: string;
+                };
+            };
+            outputFormat: "json";
+            status: 200;
+        };
+    };
+} & {
+    "/vouchers/:id/redeem": {
+        $post: {
+            input: {
+                param: {
+                    id: string;
+                };
+            } & {
+                json: {
+                    bookingId: string;
+                    amountCents: number;
+                    paymentId?: string | null | undefined;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 404;
+        } | {
+            input: {
+                param: {
+                    id: string;
+                };
+            } & {
+                json: {
+                    bookingId: string;
+                    amountCents: number;
+                    paymentId?: string | null | undefined;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 400;
+        } | {
+            input: {
+                param: {
+                    id: string;
+                };
+            } & {
+                json: {
+                    bookingId: string;
+                    amountCents: number;
+                    paymentId?: string | null | undefined;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 409;
+        } | {
+            input: {
+                param: {
+                    id: string;
+                };
+            } & {
+                json: {
+                    bookingId: string;
+                    amountCents: number;
+                    paymentId?: string | null | undefined;
+                };
+            };
+            output: {
+                data: {
+                    voucher: {
+                        id: string;
+                        code: string;
+                        seriesCode: string | null;
+                        status: "void" | "expired" | "active" | "redeemed";
+                        currency: string;
+                        initialAmountCents: number;
+                        remainingAmountCents: number;
+                        issuedToPersonId: string | null;
+                        issuedToOrganizationId: string | null;
+                        sourceType: "manual" | "refund" | "cancellation_credit" | "gift" | "promo";
+                        sourceBookingId: string | null;
+                        sourcePaymentId: string | null;
+                        validFrom: string | null;
+                        expiresAt: string | null;
+                        notes: string | null;
+                        issuedByUserId: string | null;
+                        createdAt: string;
+                        updatedAt: string;
+                    };
+                    redemption: {
+                        id: string;
+                        voucherId: string;
+                        bookingId: string;
+                        paymentId: string | null;
+                        amountCents: number;
+                        createdAt: string;
+                        createdByUserId: string | null;
+                    } | null;
+                };
+            };
+            outputFormat: "json";
+            status: 201;
+        } | {
+            input: {
+                param: {
+                    id: string;
+                };
+            } & {
+                json: {
+                    bookingId: string;
+                    amountCents: number;
+                    paymentId?: string | null | undefined;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 422;
+        };
+    };
+}, "/">, "/">;
+//# sourceMappingURL=routes-vouchers.d.ts.map

package/dist/routes-vouchers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"routes-vouchers.d.ts","sourceRoot":"","sources":["../src/routes-vouchers.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,OAAO,EAAe,WAAW,EAAK,MAAM,mBAAmB,CAAA;AAK/D,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,oBAAoB,CAAA;AAsL7C,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;aAEL,CAAA"}

package/dist/routes-vouchers.js

@@ -0,0 +1,176 @@
+/**
+ * Admin voucher routes — mounted by the operator starter under
+ * `/v1/admin/finance/...`. Covers voucher issuance, lookup, update, and
+ * redemption.
+ *
+ * Migrated to `@hono/zod-openapi` for the OpenAPI admin backfill (voyant#2114 /
+ * voyant#2208 — finance sub-batch 9C). Request schemas reuse the existing
+ * `@voyant-travel/finance-contracts` schemas the handlers already parse;
+ * response schemas come from the shared `routes-payment-schemas.ts` row shapes
+ * (authored from the Drizzle `$inferSelect` shapes; §17 dates → strings). The
+ * single voucher resource is its own `OpenAPIHono` sub-chain composed onto
+ * `financeVoucherRoutes` via `.route("/")` so the `.openapi()` operations
+ * propagate up through the parent `financeRoutes` registry.
+ */
+import { createRoute, OpenAPIHono, z } from "@hono/zod-openapi";
+import { openApiValidationHook } from "@voyant-travel/hono";
+import { listResponseSchema } from "@voyant-travel/types";
+import { errorResponseSchema } from "./routes-invoice-schemas.js";
+import { voucherRedeemResultSchema, voucherSchema } from "./routes-payment-schemas.js";
+import { financeService } from "./service.js";
+import { VoucherServiceError } from "./service-vouchers.js";
+import { insertVoucherSchema, redeemVoucherSchema, updateVoucherSchema, voucherListQuerySchema, } from "./validation.js";
+const idParamSchema = z.object({ id: z.string() });
+const listVouchersRoute = createRoute({
+    method: "get",
+    path: "/vouchers",
+    request: { query: voucherListQuerySchema },
+    responses: {
+        200: {
+            description: "List of vouchers",
+            content: { "application/json": { schema: listResponseSchema(voucherSchema) } },
+        },
+    },
+});
+const createVoucherRoute = createRoute({
+    method: "post",
+    path: "/vouchers",
+    request: {
+        body: {
+            required: true,
+            content: { "application/json": { schema: insertVoucherSchema } },
+        },
+    },
+    responses: {
+        201: {
+            description: "The issued voucher",
+            content: { "application/json": { schema: z.object({ data: voucherSchema }) } },
+        },
+        400: {
+            description: "invalid_request: request body failed validation",
+            content: { "application/json": { schema: errorResponseSchema } },
+        },
+        409: {
+            description: "The voucher code is already in use",
+            content: { "application/json": { schema: errorResponseSchema } },
+        },
+    },
+});
+const getVoucherRoute = createRoute({
+    method: "get",
+    path: "/vouchers/{id}",
+    request: { params: idParamSchema },
+    responses: {
+        200: {
+            description: "The voucher",
+            content: { "application/json": { schema: z.object({ data: voucherSchema }) } },
+        },
+        404: {
+            description: "Voucher not found",
+            content: { "application/json": { schema: errorResponseSchema } },
+        },
+    },
+});
+const updateVoucherRoute = createRoute({
+    method: "patch",
+    path: "/vouchers/{id}",
+    request: {
+        params: idParamSchema,
+        body: {
+            required: true,
+            content: { "application/json": { schema: updateVoucherSchema } },
+        },
+    },
+    responses: {
+        200: {
+            description: "The updated voucher",
+            content: { "application/json": { schema: z.object({ data: voucherSchema }) } },
+        },
+        400: {
+            description: "invalid_request: request body failed validation",
+            content: { "application/json": { schema: errorResponseSchema } },
+        },
+        404: {
+            description: "Voucher not found",
+            content: { "application/json": { schema: errorResponseSchema } },
+        },
+    },
+});
+const redeemVoucherRoute = createRoute({
+    method: "post",
+    path: "/vouchers/{id}/redeem",
+    request: {
+        params: idParamSchema,
+        body: {
+            required: true,
+            content: { "application/json": { schema: redeemVoucherSchema } },
+        },
+    },
+    responses: {
+        201: {
+            description: "The redemption (updated voucher + the recorded redemption row)",
+            content: { "application/json": { schema: z.object({ data: voucherRedeemResultSchema }) } },
+        },
+        400: {
+            description: "invalid_request: request body failed validation",
+            content: { "application/json": { schema: errorResponseSchema } },
+        },
+        404: {
+            description: "Voucher not found",
+            content: { "application/json": { schema: errorResponseSchema } },
+        },
+        409: {
+            description: "The voucher has insufficient remaining balance",
+            content: { "application/json": { schema: errorResponseSchema } },
+        },
+        422: {
+            description: "The voucher is inactive, not yet started, or expired",
+            content: { "application/json": { schema: errorResponseSchema } },
+        },
+    },
+});
+const voucherRoutes = new OpenAPIHono({ defaultHook: openApiValidationHook })
+    .openapi(listVouchersRoute, async (c) => c.json(await financeService.vouchers.list(c.get("db"), c.req.valid("query")), 200))
+    .openapi(createVoucherRoute, async (c) => {
+    try {
+        const row = await financeService.vouchers.create(c.get("db"), c.req.valid("json"), c.get("userId"));
+        if (!row) {
+            throw new Error("Failed to create voucher");
+        }
+        return c.json({ data: row }, 201);
+    }
+    catch (error) {
+        if (error instanceof VoucherServiceError && error.code === "code_in_use") {
+            return c.json({ error: "Voucher code already in use" }, 409);
+        }
+        throw error;
+    }
+})
+    .openapi(getVoucherRoute, async (c) => {
+    const row = await financeService.vouchers.getById(c.get("db"), c.req.valid("param").id);
+    return row ? c.json({ data: row }, 200) : c.json({ error: "Voucher not found" }, 404);
+})
+    .openapi(updateVoucherRoute, async (c) => {
+    const row = await financeService.vouchers.update(c.get("db"), c.req.valid("param").id, c.req.valid("json"));
+    return row ? c.json({ data: row }, 200) : c.json({ error: "Voucher not found" }, 404);
+})
+    .openapi(redeemVoucherRoute, async (c) => {
+    try {
+        const result = await financeService.vouchers.redeem(c.get("db"), c.req.valid("param").id, c.req.valid("json"), c.get("userId"));
+        return c.json({ data: result }, 201);
+    }
+    catch (error) {
+        if (error instanceof VoucherServiceError) {
+            const status = error.code === "voucher_not_found"
+                ? 404
+                : error.code === "insufficient_balance"
+                    ? 409
+                    : 422;
+            return c.json({ error: error.code }, status);
+        }
+        throw error;
+    }
+});
+export const financeVoucherRoutes = new OpenAPIHono({
+    defaultHook: openApiValidationHook,
+}).route("/", voucherRoutes);