@voyant-travel/finance 0.119.5

package/dist/service-invoice-artifacts.d.ts

@@ -0,0 +1,246 @@
+import type { BindInvoiceRenditionInput, CreateInvoiceAttachmentInput, CreateInvoiceRenditionInput, CreateInvoiceTemplateInput, FinanceServiceRuntime, InvoiceTemplateListQuery, PostgresJsDatabase, RenderInvoiceInput, UpdateInvoiceAttachmentInput, UpdateInvoiceRenditionInput, UpdateInvoiceTemplateInput } from "./service-shared.js";
+export declare const financeInvoiceArtifactService: {
+    listInvoiceTemplates(db: PostgresJsDatabase, query: InvoiceTemplateListQuery): Promise<{
+        data: {
+            id: string;
+            name: string;
+            slug: string;
+            language: string;
+            jurisdiction: string | null;
+            bodyFormat: "html" | "markdown" | "lexical_json";
+            body: string;
+            cssStyles: string | null;
+            isDefault: boolean;
+            active: boolean;
+            metadata: unknown;
+            createdAt: Date;
+            updatedAt: Date;
+        }[];
+        total: number;
+        limit: number;
+        offset: number;
+    }>;
+    getInvoiceTemplateById(db: PostgresJsDatabase, id: string): Promise<{
+        id: string;
+        name: string;
+        slug: string;
+        language: string;
+        jurisdiction: string | null;
+        bodyFormat: "html" | "markdown" | "lexical_json";
+        body: string;
+        cssStyles: string | null;
+        isDefault: boolean;
+        active: boolean;
+        metadata: unknown;
+        createdAt: Date;
+        updatedAt: Date;
+    } | null>;
+    createInvoiceTemplate(db: PostgresJsDatabase, data: CreateInvoiceTemplateInput): Promise<{
+        id: string;
+        name: string;
+        jurisdiction: string | null;
+        active: boolean;
+        createdAt: Date;
+        updatedAt: Date;
+        metadata: unknown;
+        language: string;
+        isDefault: boolean;
+        slug: string;
+        bodyFormat: "html" | "markdown" | "lexical_json";
+        body: string;
+        cssStyles: string | null;
+    } | null>;
+    updateInvoiceTemplate(db: PostgresJsDatabase, id: string, data: UpdateInvoiceTemplateInput): Promise<{
+        id: string;
+        name: string;
+        slug: string;
+        language: string;
+        jurisdiction: string | null;
+        bodyFormat: "html" | "markdown" | "lexical_json";
+        body: string;
+        cssStyles: string | null;
+        isDefault: boolean;
+        active: boolean;
+        metadata: unknown;
+        createdAt: Date;
+        updatedAt: Date;
+    } | null>;
+    deleteInvoiceTemplate(db: PostgresJsDatabase, id: string): Promise<{
+        id: string;
+    } | null>;
+    listInvoiceRenditions(db: PostgresJsDatabase, invoiceId: string): Promise<{
+        id: string;
+        invoiceId: string;
+        templateId: string | null;
+        format: "json" | "html" | "pdf" | "xml";
+        status: "failed" | "pending" | "ready" | "stale";
+        storageKey: string | null;
+        fileSize: number | null;
+        checksum: string | null;
+        language: string | null;
+        errorMessage: string | null;
+        generatedAt: Date | null;
+        metadata: unknown;
+        createdAt: Date;
+        updatedAt: Date;
+    }[]>;
+    getInvoiceRenditionById(db: PostgresJsDatabase, id: string): Promise<{
+        id: string;
+        invoiceId: string;
+        templateId: string | null;
+        format: "json" | "html" | "pdf" | "xml";
+        status: "failed" | "pending" | "ready" | "stale";
+        storageKey: string | null;
+        fileSize: number | null;
+        checksum: string | null;
+        language: string | null;
+        errorMessage: string | null;
+        generatedAt: Date | null;
+        metadata: unknown;
+        createdAt: Date;
+        updatedAt: Date;
+    } | null>;
+    createInvoiceRendition(db: PostgresJsDatabase, invoiceId: string, data: CreateInvoiceRenditionInput): Promise<{
+        format: "json" | "html" | "pdf" | "xml";
+        id: string;
+        createdAt: Date;
+        updatedAt: Date;
+        metadata: unknown;
+        status: "failed" | "pending" | "ready" | "stale";
+        errorMessage: string | null;
+        invoiceId: string;
+        templateId: string | null;
+        language: string | null;
+        storageKey: string | null;
+        fileSize: number | null;
+        checksum: string | null;
+        generatedAt: Date | null;
+    } | null>;
+    updateInvoiceRendition(db: PostgresJsDatabase, id: string, data: UpdateInvoiceRenditionInput): Promise<{
+        id: string;
+        invoiceId: string;
+        templateId: string | null;
+        format: "json" | "html" | "pdf" | "xml";
+        status: "failed" | "pending" | "ready" | "stale";
+        storageKey: string | null;
+        fileSize: number | null;
+        checksum: string | null;
+        language: string | null;
+        errorMessage: string | null;
+        generatedAt: Date | null;
+        metadata: unknown;
+        createdAt: Date;
+        updatedAt: Date;
+    } | null>;
+    bindInvoiceRendition(db: PostgresJsDatabase, invoiceId: string, data: BindInvoiceRenditionInput, runtime?: FinanceServiceRuntime): Promise<{
+        status: "not_found";
+        invoice?: undefined;
+        rendition?: undefined;
+    } | {
+        status: "bound";
+        invoice: {
+            id: string;
+            status: "void" | "paid" | "draft" | "pending_external_allocation" | "issued" | "partially_paid" | "overdue";
+            invoiceType: "invoice" | "proforma" | "credit_note";
+        };
+        rendition: {
+            format: "json" | "html" | "pdf" | "xml";
+            id: string;
+            createdAt: Date;
+            updatedAt: Date;
+            metadata: unknown;
+            status: "failed" | "pending" | "ready" | "stale";
+            errorMessage: string | null;
+            invoiceId: string;
+            templateId: string | null;
+            language: string | null;
+            storageKey: string | null;
+            fileSize: number | null;
+            checksum: string | null;
+            generatedAt: Date | null;
+        };
+    }>;
+    deleteInvoiceRendition(db: PostgresJsDatabase, id: string): Promise<{
+        id: string;
+    } | null>;
+    listInvoiceAttachments(db: PostgresJsDatabase, invoiceId: string): Promise<{
+        id: string;
+        invoiceId: string;
+        kind: string;
+        name: string;
+        mimeType: string | null;
+        fileSize: number | null;
+        storageKey: string | null;
+        checksum: string | null;
+        metadata: unknown;
+        createdAt: Date;
+    }[]>;
+    getInvoiceAttachmentById(db: PostgresJsDatabase, id: string): Promise<{
+        id: string;
+        invoiceId: string;
+        kind: string;
+        name: string;
+        mimeType: string | null;
+        fileSize: number | null;
+        storageKey: string | null;
+        checksum: string | null;
+        metadata: unknown;
+        createdAt: Date;
+    } | null>;
+    createInvoiceAttachment(db: PostgresJsDatabase, invoiceId: string, data: CreateInvoiceAttachmentInput): Promise<{
+        id: string;
+        name: string;
+        createdAt: Date;
+        metadata: unknown;
+        invoiceId: string;
+        kind: string;
+        storageKey: string | null;
+        fileSize: number | null;
+        checksum: string | null;
+        mimeType: string | null;
+    } | null>;
+    updateInvoiceAttachment(db: PostgresJsDatabase, invoiceId: string, id: string, data: UpdateInvoiceAttachmentInput): Promise<{
+        id: string;
+        invoiceId: string;
+        kind: string;
+        name: string;
+        mimeType: string | null;
+        fileSize: number | null;
+        storageKey: string | null;
+        checksum: string | null;
+        metadata: unknown;
+        createdAt: Date;
+    } | null>;
+    deleteInvoiceAttachment(db: PostgresJsDatabase, invoiceId: string, id: string): Promise<{
+        id: string;
+    } | null>;
+    /**
+     * Request an invoice rendition. Creates a `pending` rendition row pointing
+     * to a template; the actual rendering (HTML→PDF) is expected to be
+     * performed out-of-band by a background job that updates the rendition to
+     * `ready` with `storageKey` set.
+     */
+    renderInvoice(db: PostgresJsDatabase, invoiceId: string, input: RenderInvoiceInput): Promise<{
+        status: "not_found";
+        rendition?: undefined;
+    } | {
+        status: "requested";
+        rendition: {
+            format: "json" | "html" | "pdf" | "xml";
+            id: string;
+            createdAt: Date;
+            updatedAt: Date;
+            metadata: unknown;
+            status: "failed" | "pending" | "ready" | "stale";
+            errorMessage: string | null;
+            invoiceId: string;
+            templateId: string | null;
+            language: string | null;
+            storageKey: string | null;
+            fileSize: number | null;
+            checksum: string | null;
+            generatedAt: Date | null;
+        } | null;
+    }>;
+};
+//# sourceMappingURL=service-invoice-artifacts.d.ts.map

package/dist/service-invoice-artifacts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"service-invoice-artifacts.d.ts","sourceRoot":"","sources":["../src/service-invoice-artifacts.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,yBAAyB,EACzB,4BAA4B,EAC5B,2BAA2B,EAC3B,0BAA0B,EAC1B,qBAAqB,EAErB,wBAAwB,EACxB,kBAAkB,EAClB,kBAAkB,EAClB,4BAA4B,EAC5B,2BAA2B,EAC3B,0BAA0B,EAC3B,MAAM,qBAAqB,CAAA;AAiB5B,eAAO,MAAM,6BAA6B;6BACT,kBAAkB,SAAS,wBAAwB;;;;;;;;;;;;;;;;;;;;+BAyBjD,kBAAkB,MAAM,MAAM;;;;;;;;;;;;;;;8BAS/B,kBAAkB,QAAQ,0BAA0B;;;;;;;;;;;;;;;8BAoB9E,kBAAkB,MAClB,MAAM,QACJ,0BAA0B;;;;;;;;;;;;;;;8BAUF,kBAAkB,MAAM,MAAM;;;8BAY9B,kBAAkB,aAAa,MAAM;;;;;;;;;;;;;;;;gCAQnC,kBAAkB,MAAM,MAAM;;;;;;;;;;;;;;;;+BAU1D,kBAAkB,aACX,MAAM,QACX,2BAA2B;;;;;;;;;;;;;;;;+BA6B7B,kBAAkB,MAClB,MAAM,QACJ,2BAA2B;;;;;;;;;;;;;;;;6BAgB7B,kBAAkB,aACX,MAAM,QACX,yBAAyB,YACtB,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;+BA8EC,kBAAkB,MAAM,MAAM;;;+BAY9B,kBAAkB,aAAa,MAAM;;;;;;;;;;;;iCAQnC,kBAAkB,MAAM,MAAM;;;;;;;;;;;;gCAU3D,kBAAkB,aACX,MAAM,QACX,4BAA4B;;;;;;;;;;;;gCA0B9B,kBAAkB,aACX,MAAM,MACb,MAAM,QACJ,4BAA4B;;;;;;;;;;;;gCAUF,kBAAkB,aAAa,MAAM,MAAM,MAAM;;;IAQnF;;;;;OAKG;sBACqB,kBAAkB,aAAa,MAAM,SAAS,kBAAkB;;;;;;;;;;;;;;;;;;;;;;CA4BzF,CAAA"}

package/dist/service-invoice-artifacts.js

@@ -0,0 +1,277 @@
+import { and, desc, eq, ilike, invoiceAttachments, invoiceRenditions, invoices, invoiceTemplates, ne, or, paginate, sql, toTimestamp, } from "./service-shared.js";
+export const financeInvoiceArtifactService = {
+    async listInvoiceTemplates(db, query) {
+        const conditions = [];
+        if (query.language)
+            conditions.push(eq(invoiceTemplates.language, query.language));
+        if (query.jurisdiction)
+            conditions.push(eq(invoiceTemplates.jurisdiction, query.jurisdiction));
+        if (typeof query.active === "boolean")
+            conditions.push(eq(invoiceTemplates.active, query.active));
+        if (query.search) {
+            const term = `%${query.search}%`;
+            conditions.push(or(ilike(invoiceTemplates.name, term), ilike(invoiceTemplates.slug, term)));
+        }
+        const where = conditions.length ? and(...conditions) : undefined;
+        return paginate(db
+            .select()
+            .from(invoiceTemplates)
+            .where(where)
+            .limit(query.limit)
+            .offset(query.offset)
+            .orderBy(desc(invoiceTemplates.updatedAt)), db.select({ total: sql `count(*)::int` }).from(invoiceTemplates).where(where), query.limit, query.offset);
+    },
+    async getInvoiceTemplateById(db, id) {
+        const [row] = await db
+            .select()
+            .from(invoiceTemplates)
+            .where(eq(invoiceTemplates.id, id))
+            .limit(1);
+        return row ?? null;
+    },
+    async createInvoiceTemplate(db, data) {
+        const [row] = await db
+            .insert(invoiceTemplates)
+            .values({
+            name: data.name,
+            slug: data.slug,
+            language: data.language,
+            jurisdiction: data.jurisdiction ?? null,
+            bodyFormat: data.bodyFormat,
+            body: data.body,
+            cssStyles: data.cssStyles ?? null,
+            isDefault: data.isDefault,
+            active: data.active,
+            metadata: data.metadata ?? null,
+        })
+            .returning();
+        return row ?? null;
+    },
+    async updateInvoiceTemplate(db, id, data) {
+        const [row] = await db
+            .update(invoiceTemplates)
+            .set({ ...data, updatedAt: new Date() })
+            .where(eq(invoiceTemplates.id, id))
+            .returning();
+        return row ?? null;
+    },
+    async deleteInvoiceTemplate(db, id) {
+        const [row] = await db
+            .delete(invoiceTemplates)
+            .where(eq(invoiceTemplates.id, id))
+            .returning({ id: invoiceTemplates.id });
+        return row ?? null;
+    },
+    // ============================================================================
+    // Invoice renditions
+    // ============================================================================
+    async listInvoiceRenditions(db, invoiceId) {
+        return db
+            .select()
+            .from(invoiceRenditions)
+            .where(eq(invoiceRenditions.invoiceId, invoiceId))
+            .orderBy(desc(invoiceRenditions.createdAt));
+    },
+    async getInvoiceRenditionById(db, id) {
+        const [row] = await db
+            .select()
+            .from(invoiceRenditions)
+            .where(eq(invoiceRenditions.id, id))
+            .limit(1);
+        return row ?? null;
+    },
+    async createInvoiceRendition(db, invoiceId, data) {
+        const [invoice] = await db
+            .select({ id: invoices.id })
+            .from(invoices)
+            .where(eq(invoices.id, invoiceId))
+            .limit(1);
+        if (!invoice)
+            return null;
+        const [row] = await db
+            .insert(invoiceRenditions)
+            .values({
+            invoiceId,
+            templateId: data.templateId ?? null,
+            format: data.format,
+            status: data.status,
+            storageKey: data.storageKey ?? null,
+            fileSize: data.fileSize ?? null,
+            checksum: data.checksum ?? null,
+            language: data.language ?? null,
+            errorMessage: data.errorMessage ?? null,
+            generatedAt: toTimestamp(data.generatedAt),
+            metadata: data.metadata ?? null,
+        })
+            .returning();
+        return row ?? null;
+    },
+    async updateInvoiceRendition(db, id, data) {
+        const { generatedAt, ...rest } = data;
+        const [row] = await db
+            .update(invoiceRenditions)
+            .set({
+            ...rest,
+            ...(generatedAt !== undefined ? { generatedAt: toTimestamp(generatedAt) } : {}),
+            updatedAt: new Date(),
+        })
+            .where(eq(invoiceRenditions.id, id))
+            .returning();
+        return row ?? null;
+    },
+    async bindInvoiceRendition(db, invoiceId, data, runtime = {}) {
+        const result = await db.transaction(async (tx) => {
+            const [invoice] = await tx
+                .select({
+                id: invoices.id,
+                status: invoices.status,
+                invoiceType: invoices.invoiceType,
+            })
+                .from(invoices)
+                .where(eq(invoices.id, invoiceId))
+                .limit(1);
+            if (!invoice)
+                return { status: "not_found" };
+            if (data.replaceExisting) {
+                await tx
+                    .update(invoiceRenditions)
+                    .set({ status: "stale", updatedAt: new Date() })
+                    .where(and(eq(invoiceRenditions.invoiceId, invoiceId), eq(invoiceRenditions.format, data.format), ne(invoiceRenditions.status, "stale")));
+            }
+            const [rendition] = await tx
+                .insert(invoiceRenditions)
+                .values({
+                invoiceId,
+                templateId: data.templateId ?? null,
+                format: data.format,
+                status: "ready",
+                storageKey: data.storageKey?.trim() || null,
+                fileSize: data.fileSize ?? null,
+                checksum: data.checksum ?? null,
+                language: data.language ?? null,
+                generatedAt: toTimestamp(data.generatedAt),
+                metadata: {
+                    ...(data.metadata ?? {}),
+                    contentType: data.contentType,
+                },
+            })
+                .returning();
+            if (!rendition)
+                return { status: "not_found" };
+            return { status: "bound", invoice, rendition };
+        });
+        if (result.status !== "bound") {
+            return result;
+        }
+        await runtime.eventBus?.emit("invoice.rendered", {
+            invoiceId: result.invoice.id,
+            invoiceStatus: result.invoice.status,
+            invoiceType: result.invoice.invoiceType,
+            renditionId: result.rendition.id,
+            format: result.rendition.format,
+            storageKey: result.rendition.storageKey,
+            contentType: data.contentType,
+            byteSize: result.rendition.fileSize,
+            contentHash: result.rendition.checksum,
+        }, {
+            category: "internal",
+            source: "service",
+        });
+        return result;
+    },
+    async deleteInvoiceRendition(db, id) {
+        const [row] = await db
+            .delete(invoiceRenditions)
+            .where(eq(invoiceRenditions.id, id))
+            .returning({ id: invoiceRenditions.id });
+        return row ?? null;
+    },
+    // ============================================================================
+    // Invoice attachments
+    // ============================================================================
+    async listInvoiceAttachments(db, invoiceId) {
+        return db
+            .select()
+            .from(invoiceAttachments)
+            .where(eq(invoiceAttachments.invoiceId, invoiceId))
+            .orderBy(desc(invoiceAttachments.createdAt));
+    },
+    async getInvoiceAttachmentById(db, id) {
+        const [row] = await db
+            .select()
+            .from(invoiceAttachments)
+            .where(eq(invoiceAttachments.id, id))
+            .limit(1);
+        return row ?? null;
+    },
+    async createInvoiceAttachment(db, invoiceId, data) {
+        const [invoice] = await db
+            .select({ id: invoices.id })
+            .from(invoices)
+            .where(eq(invoices.id, invoiceId))
+            .limit(1);
+        if (!invoice)
+            return null;
+        const [row] = await db
+            .insert(invoiceAttachments)
+            .values({
+            invoiceId,
+            kind: data.kind,
+            name: data.name,
+            mimeType: data.mimeType ?? null,
+            fileSize: data.fileSize ?? null,
+            storageKey: data.storageKey ?? null,
+            checksum: data.checksum ?? null,
+            metadata: data.metadata ?? null,
+        })
+            .returning();
+        return row ?? null;
+    },
+    async updateInvoiceAttachment(db, invoiceId, id, data) {
+        const [row] = await db
+            .update(invoiceAttachments)
+            .set(data)
+            .where(and(eq(invoiceAttachments.id, id), eq(invoiceAttachments.invoiceId, invoiceId)))
+            .returning();
+        return row ?? null;
+    },
+    async deleteInvoiceAttachment(db, invoiceId, id) {
+        const [row] = await db
+            .delete(invoiceAttachments)
+            .where(and(eq(invoiceAttachments.id, id), eq(invoiceAttachments.invoiceId, invoiceId)))
+            .returning({ id: invoiceAttachments.id });
+        return row ?? null;
+    },
+    /**
+     * Request an invoice rendition. Creates a `pending` rendition row pointing
+     * to a template; the actual rendering (HTML→PDF) is expected to be
+     * performed out-of-band by a background job that updates the rendition to
+     * `ready` with `storageKey` set.
+     */
+    async renderInvoice(db, invoiceId, input) {
+        const [invoice] = await db.select().from(invoices).where(eq(invoices.id, invoiceId)).limit(1);
+        if (!invoice)
+            return { status: "not_found" };
+        // Resolve template: explicit input > invoice.templateId > default template
+        let templateId = input.templateId ?? invoice.templateId ?? null;
+        if (!templateId) {
+            const [defaultTemplate] = await db
+                .select({ id: invoiceTemplates.id })
+                .from(invoiceTemplates)
+                .where(and(eq(invoiceTemplates.isDefault, true), eq(invoiceTemplates.active, true)))
+                .limit(1);
+            templateId = defaultTemplate?.id ?? null;
+        }
+        const [row] = await db
+            .insert(invoiceRenditions)
+            .values({
+            invoiceId,
+            templateId,
+            format: input.format,
+            status: "pending",
+            language: input.language ?? invoice.language ?? null,
+        })
+            .returning();
+        return { status: "requested", rendition: row ?? null };
+    },
+};