@openlup/platform 0.16.0 → 0.18.0

package/dist/communications/contracts/orderCanceled.d.ts

@@ -0,0 +1,25 @@
+import type { CommerceEmailContent } from "./commerceEmailContent.js";
+import type { Locale } from "./email.js";
+import { type EmailBlock } from "./blocks.js";
+export interface OrderCanceledEmailVars {
+    firstName: string | null;
+    orderId: string;
+    /** Formatted gross total, e.g. "129,99 zł", or null when unknown. */
+    amountLabel: string | null;
+    /** Absolute CTA URL (back to shop); null/absent → no button. */
+    ctaUrl?: string | null;
+    /** Optional context name for the selected return note. */
+    contextName?: string | null;
+}
+export interface OrderCanceledEmailContent {
+    subject: string;
+    preheader: string;
+    blocks: EmailBlock[];
+}
+/** Bind host-selected copy and pure helpers without provider or environment access. */
+export declare function createOrderCanceledContentFactory(input: {
+    commerceEmailContent: Pick<CommerceEmailContent, "orderCanceled" | "orderRefPrefix">;
+    formatCustomerOrderReference: (orderId: string, prefix: string) => string;
+}): {
+    orderCanceledEmailContent: (locale: Locale, vars: OrderCanceledEmailVars, signoff: string) => OrderCanceledEmailContent;
+};

package/dist/communications/contracts/orderCanceled.js

@@ -0,0 +1,27 @@
+import { accentBox, button, heading, paragraph, } from "./blocks.js";
+/** Bind host-selected copy and pure helpers without provider or environment access. */
+export function createOrderCanceledContentFactory(input) {
+    const { commerceEmailContent, formatCustomerOrderReference } = input;
+    function orderCanceledEmailContent(locale, vars, signoff) {
+        const copy = commerceEmailContent.orderCanceled[locale];
+        const orderRef = formatCustomerOrderReference(vars.orderId, commerceEmailContent.orderRefPrefix);
+        const blocks = [
+            heading(copy.heading),
+            paragraph(copy.greeting(vars.firstName)),
+            paragraph(copy.intro(orderRef)),
+            accentBox(copy.details(vars.amountLabel), { label: copy.detailsLabel }),
+            paragraph(copy.returnNote(vars.contextName ?? null)),
+        ];
+        if (vars.ctaUrl) {
+            blocks.push(button(copy.cta, vars.ctaUrl));
+        }
+        blocks.push(paragraph(copy.outro));
+        blocks.push(paragraph(signoff));
+        return {
+            subject: copy.subject(orderRef),
+            preheader: copy.preheader,
+            blocks,
+        };
+    }
+    return { orderCanceledEmailContent };
+}

package/dist/communications/contracts/orderDraft.d.ts

@@ -0,0 +1,46 @@
+import type { CommerceEmailContent } from "./commerceEmailContent.js";
+import type { Locale } from "./email.js";
+import { type EmailBlock } from "./blocks.js";
+export interface OrderDraftLineItem {
+    /** Resolved, localized product name (or slug/sku fallback). */
+    name: string;
+    quantity: number;
+    /** Formatted gross line total, e.g. "129,98 zł"; "" when price unknown. */
+    lineTotalLabel: string;
+}
+export interface OrderDraftTotals {
+    /** null → omit the subtotal row (value unknown); never alias the grand total. */
+    subtotalLabel: string | null;
+    /** Already sign-prefixed, e.g. "-20,00 zł"; null → no discount row. */
+    discountLabel: string | null;
+    totalLabel: string;
+}
+export interface OrderDraftEmailVars {
+    firstName: string | null;
+    /** Technical order id from outbox, e.g. "order_<uuid>". */
+    orderId: string;
+    /** Itemized order lines (name × qty + line total). */
+    items: OrderDraftLineItem[];
+    /** Money breakdown, or null when totals are unknown. */
+    totals: OrderDraftTotals | null;
+    /** Absolute CTA URL back to the configurator; null/absent → no button. */
+    ctaUrl?: string | null;
+    /**
+     * Dog's name from the owner's survey, when known. Drives an optional warm
+     * closing line. Absent/null (e.g. anonymous drafts) → the line is omitted.
+     * Never inflect the copy by gender: the name doesn't reveal it.
+     */
+    contextName?: string | null;
+}
+export interface OrderDraftEmailContent {
+    subject: string;
+    preheader: string;
+    blocks: EmailBlock[];
+}
+/** Bind host-selected copy and pure helpers without provider or environment access. */
+export declare function createOrderDraftContentFactory(input: {
+    commerceEmailContent: Pick<CommerceEmailContent, "orderDraft" | "orderRefPrefix">;
+    formatCustomerOrderReference: (orderId: string, prefix: string) => string;
+}): {
+    orderDraftEmailContent: (locale: Locale, vars: OrderDraftEmailVars, signoff: string) => OrderDraftEmailContent;
+};

package/dist/communications/contracts/orderDraft.js

@@ -0,0 +1,46 @@
+import { button, dataTable, heading, list, paragraph, } from "./blocks.js";
+/** Bind host-selected copy and pure helpers without provider or environment access. */
+export function createOrderDraftContentFactory(input) {
+    const { commerceEmailContent, formatCustomerOrderReference } = input;
+    function itemLine(item) {
+        const base = `${item.quantity}× ${item.name}`;
+        return item.lineTotalLabel ? `${base} – ${item.lineTotalLabel}` : base;
+    }
+    function orderDraftEmailContent(locale, vars, signoff) {
+        const copy = commerceEmailContent.orderDraft[locale];
+        const orderRef = formatCustomerOrderReference(vars.orderId, commerceEmailContent.orderRefPrefix);
+        const blocks = [
+            heading(copy.heading),
+            paragraph(copy.greeting(vars.firstName)),
+            paragraph(copy.intro(orderRef)),
+        ];
+        blocks.push(vars.items.length > 0
+            ? list(vars.items.map(itemLine))
+            : paragraph(copy.noItems));
+        if (vars.totals) {
+            const rows = [];
+            if (vars.totals.subtotalLabel) {
+                rows.push({ label: copy.subtotalLabel, value: vars.totals.subtotalLabel });
+            }
+            if (vars.totals.discountLabel) {
+                rows.push({ label: copy.discountRowLabel, value: vars.totals.discountLabel });
+            }
+            rows.push({ label: copy.totalLabel, value: vars.totals.totalLabel });
+            blocks.push(dataTable(rows));
+        }
+        if (vars.ctaUrl) {
+            blocks.push(button(copy.cta, vars.ctaUrl));
+        }
+        blocks.push(paragraph(copy.outro));
+        if (vars.contextName) {
+            blocks.push(paragraph(copy.personalizedClosing(vars.contextName)));
+        }
+        blocks.push(paragraph(signoff));
+        return {
+            subject: copy.subject(orderRef),
+            preheader: copy.preheader,
+            blocks,
+        };
+    }
+    return { orderDraftEmailContent };
+}

package/dist/communications/contracts/orderPaid.d.ts

@@ -0,0 +1,53 @@
+import type { CommerceEmailContent } from "./commerceEmailContent.js";
+import type { Locale } from "./email.js";
+import { type EmailBlock } from "./blocks.js";
+export interface OrderPaidLineItem {
+    name: string;
+    quantity: number;
+    lineTotalLabel: string;
+}
+export interface OrderPaidTotals {
+    /** null → omit the subtotal row (value unknown); never alias the grand total. */
+    subtotalLabel: string | null;
+    discountLabel: string | null;
+    totalLabel: string;
+    firstSubscription?: {
+        catalogLabel: string;
+        productPayableLabel: string;
+        shippingLabel: string | null;
+        shippingFree: boolean;
+    };
+}
+export interface OrderPaidEmailVars {
+    firstName: string | null;
+    orderId: string;
+    /** "one_time" | "subscription_cycle" (free-form); drives the intro framing. */
+    mode: string;
+    items: OrderPaidLineItem[];
+    totals: OrderPaidTotals | null;
+    /** Absolute CTA URL to the customer's order/account; null/absent → no button. */
+    ctaUrl?: string | null;
+    /**
+     * Absolute URL of the shop terms (which include the §10 withdrawal-right
+     * section and the model withdrawal form). Renders the consumer-law footer
+     * link; the fine-print paragraph itself is always included (durable-medium
+     * confirmation duty, art. 21 ustawy o prawach konsumenta).
+     */
+    termsUrl?: string | null;
+    /** Optional context name for the selected post-receipt note. */
+    contextName?: string | null;
+    /** Adopter-formatted, already-localized note about the parcel; null or absent renders nothing. */
+    parcelNote?: string | null;
+}
+export interface OrderPaidEmailContent {
+    subject: string;
+    preheader: string;
+    blocks: EmailBlock[];
+}
+/** Bind host-selected copy and pure helpers without provider or environment access. */
+export declare function createOrderPaidContentFactory(input: {
+    commerceEmailContent: Pick<CommerceEmailContent, "orderPaid" | "orderRefPrefix">;
+    formatCustomerOrderReference: (orderId: string, prefix: string) => string;
+}): {
+    orderPaidEmailContent: (locale: Locale, vars: OrderPaidEmailVars, signoff: string) => OrderPaidEmailContent;
+};

package/dist/communications/contracts/orderPaid.js

@@ -0,0 +1,71 @@
+import { button, dataTable, heading, linkParagraph, list, paragraph, } from "./blocks.js";
+/** Bind host-selected copy and pure helpers without provider or environment access. */
+export function createOrderPaidContentFactory(input) {
+    const { commerceEmailContent, formatCustomerOrderReference } = input;
+    function itemLine(item) {
+        const base = `${item.quantity}× ${item.name}`;
+        return item.lineTotalLabel ? `${base} – ${item.lineTotalLabel}` : base;
+    }
+    function orderPaidEmailContent(locale, vars, signoff) {
+        const copy = commerceEmailContent.orderPaid[locale];
+        const orderRef = formatCustomerOrderReference(vars.orderId, commerceEmailContent.orderRefPrefix);
+        const intro = vars.mode === "subscription_cycle"
+            ? copy.introSubscription(orderRef)
+            : copy.introOneTime(orderRef);
+        const blocks = [
+            heading(copy.heading),
+            paragraph(copy.greeting(vars.firstName)),
+            paragraph(intro),
+        ];
+        blocks.push(vars.items.length > 0 ? list(vars.items.map(itemLine)) : paragraph(copy.noItems));
+        if (vars.parcelNote)
+            blocks.push(paragraph(vars.parcelNote));
+        if (vars.totals) {
+            const rows = [];
+            if (vars.totals.firstSubscription) {
+                rows.push({ label: copy.catalogProductsLabel, value: vars.totals.firstSubscription.catalogLabel });
+                if (vars.totals.discountLabel) {
+                    rows.push({ label: copy.firstSubscriptionDiscountRowLabel, value: vars.totals.discountLabel });
+                }
+                rows.push({ label: copy.productPayableLabel, value: vars.totals.firstSubscription.productPayableLabel });
+                if (vars.totals.firstSubscription.shippingFree) {
+                    rows.push({ label: copy.shippingLabel, value: copy.shippingFree });
+                }
+                else if (vars.totals.firstSubscription.shippingLabel) {
+                    rows.push({ label: copy.shippingLabel, value: vars.totals.firstSubscription.shippingLabel });
+                }
+            }
+            else if (vars.totals.subtotalLabel) {
+                rows.push({ label: copy.subtotalLabel, value: vars.totals.subtotalLabel });
+            }
+            if (!vars.totals.firstSubscription && vars.totals.discountLabel) {
+                rows.push({ label: copy.discountRowLabel, value: vars.totals.discountLabel });
+            }
+            rows.push({
+                label: vars.totals.firstSubscription ? copy.finalPaidLabel : copy.totalLabel,
+                value: vars.totals.totalLabel,
+            });
+            blocks.push(dataTable(rows));
+        }
+        // Selected post-receipt copy is shown for both one-time and subscription-cycle
+        // receipts, without changing the payment or delivery facts around it.
+        blocks.push(paragraph(copy.receiptNote(vars.contextName ?? null)));
+        if (vars.ctaUrl) {
+            blocks.push(button(copy.cta, vars.ctaUrl));
+        }
+        blocks.push(paragraph(copy.outro));
+        // Durable-medium confirmation (art. 21 uPK): the receipt must carry the
+        // withdrawal-right information alongside a link to the full terms + form.
+        blocks.push(paragraph(copy.withdrawalNotice, { muted: true }));
+        if (vars.termsUrl) {
+            blocks.push(linkParagraph(copy.withdrawalLinkLabel, vars.termsUrl, { muted: true }));
+        }
+        blocks.push(paragraph(signoff));
+        return {
+            subject: copy.subject(orderRef),
+            preheader: copy.preheader,
+            blocks,
+        };
+    }
+    return { orderPaidEmailContent };
+}

package/dist/communications/contracts/orderRefunded.d.ts

@@ -0,0 +1,24 @@
+import type { CommerceEmailContent } from "./commerceEmailContent.js";
+import type { Locale } from "./email.js";
+import { type EmailBlock } from "./blocks.js";
+export interface OrderRefundedEmailVars {
+    firstName: string | null;
+    brandName: string;
+    orderId: string;
+    /** Formatted gross refund total, e.g. "129,99 zł", or null when unknown. */
+    amountLabel: string | null;
+    /** Absolute CTA URL (back to shop); null/absent → no button. */
+    ctaUrl?: string | null;
+}
+export interface OrderRefundedEmailContent {
+    subject: string;
+    preheader: string;
+    blocks: EmailBlock[];
+}
+/** Bind host-selected copy and pure helpers without provider or environment access. */
+export declare function createOrderRefundedContentFactory(input: {
+    commerceEmailContent: Pick<CommerceEmailContent, "orderRefunded" | "orderRefPrefix">;
+    formatCustomerOrderReference: (orderId: string, prefix: string) => string;
+}): {
+    orderRefundedEmailContent: (locale: Locale, vars: OrderRefundedEmailVars, signoff: string) => OrderRefundedEmailContent;
+};

package/dist/communications/contracts/orderRefunded.js

@@ -0,0 +1,27 @@
+import { accentBox, button, heading, paragraph, } from "./blocks.js";
+/** Bind host-selected copy and pure helpers without provider or environment access. */
+export function createOrderRefundedContentFactory(input) {
+    const { commerceEmailContent, formatCustomerOrderReference } = input;
+    function orderRefundedEmailContent(locale, vars, signoff) {
+        const copy = commerceEmailContent.orderRefunded[locale];
+        const orderRef = formatCustomerOrderReference(vars.orderId, commerceEmailContent.orderRefPrefix);
+        const blocks = [
+            heading(copy.heading),
+            paragraph(copy.greeting(vars.firstName)),
+            paragraph(copy.intro(orderRef)),
+            accentBox(copy.details(vars.amountLabel), { label: copy.detailsLabel }),
+            paragraph(copy.returnNote(vars.brandName)),
+        ];
+        if (vars.ctaUrl) {
+            blocks.push(button(copy.cta, vars.ctaUrl));
+        }
+        blocks.push(paragraph(copy.outro));
+        blocks.push(paragraph(signoff));
+        return {
+            subject: copy.subject(orderRef),
+            preheader: copy.preheader,
+            blocks,
+        };
+    }
+    return { orderRefundedEmailContent };
+}

package/dist/communications/contracts/paymentFailed.d.ts

@@ -0,0 +1,24 @@
+import type { CommerceEmailContent } from "./commerceEmailContent.js";
+import type { Locale } from "./email.js";
+import { type EmailBlock } from "./blocks.js";
+export interface PaymentFailedEmailVars {
+    firstName: string | null;
+    orderId: string;
+    /** Formatted gross total, e.g. "129,99 zł", or null when unknown. */
+    amountLabel: string | null;
+    mode: "subscription_cycle" | "one_time";
+    /** Absolute tokenized /konto/... recovery URL for the same order context. */
+    recoveryUrl: string;
+}
+export interface PaymentFailedEmailContent {
+    subject: string;
+    preheader: string;
+    blocks: EmailBlock[];
+}
+/** Bind host-selected copy and pure helpers without provider or environment access. */
+export declare function createPaymentFailedContentFactory(input: {
+    commerceEmailContent: Pick<CommerceEmailContent, "paymentFailed" | "orderRefPrefix">;
+    formatCustomerOrderReference: (orderId: string, prefix: string) => string;
+}): {
+    paymentFailedEmailContent: (locale: Locale, vars: PaymentFailedEmailVars, signoff: string) => PaymentFailedEmailContent;
+};

package/dist/communications/contracts/paymentFailed.js

@@ -0,0 +1,24 @@
+import { accentBox, button, heading, paragraph, } from "./blocks.js";
+/** Bind host-selected copy and pure helpers without provider or environment access. */
+export function createPaymentFailedContentFactory(input) {
+    const { commerceEmailContent, formatCustomerOrderReference } = input;
+    function paymentFailedEmailContent(locale, vars, signoff) {
+        const copy = commerceEmailContent.paymentFailed[locale];
+        const orderRef = formatCustomerOrderReference(vars.orderId, commerceEmailContent.orderRefPrefix);
+        const blocks = [
+            heading(copy.heading),
+            paragraph(copy.greeting(vars.firstName)),
+            paragraph(copy.intro(orderRef)),
+            accentBox(copy.details(vars.amountLabel, vars.mode), { label: copy.detailsLabel }),
+            button(copy.cta, vars.recoveryUrl),
+        ];
+        blocks.push(paragraph(copy.outro));
+        blocks.push(paragraph(signoff));
+        return {
+            subject: copy.subject(orderRef),
+            preheader: copy.preheader,
+            blocks,
+        };
+    }
+    return { paymentFailedEmailContent };
+}

package/dist/communications/contracts/publicIntake.d.ts

@@ -0,0 +1,49 @@
+/** Delivery seam for public intake capabilities. */
+export type PublicIntakeDeliveryPurpose = "transactional" | "admin_notification";
+export type PublicIntakeRecipientKind = "external_contact" | "admin_internal";
+export interface PublicIntakePolicyDecision {
+    allowed: boolean;
+    reason: string;
+    decisionId: string | null;
+}
+export interface PublicIntakeDeliveryResult {
+    /** The delivery implementation returned a durable message identifier. */
+    accepted: boolean;
+    messageId: string | null;
+    /** A policy or explicit no-egress terminal outcome. */
+    skip: string | null;
+    /** A non-sent terminal outcome, including an ambiguous provider acceptance. */
+    error: string | null;
+}
+export interface PublicIntakeDeliveryMessage {
+    sender: string;
+    to: string;
+    subject: string;
+    html: string;
+    text?: string;
+    replyTo?: string;
+}
+export interface PublicIntakeDeliveryPort {
+    evaluatePolicy(input: {
+        email: string | null | undefined;
+        purpose: PublicIntakeDeliveryPurpose;
+        source: string;
+        recipientKind: PublicIntakeRecipientKind;
+        sourceTable?: "b2b_inquiries";
+        sourceId?: string | null;
+        metadata: Record<string, unknown>;
+    }): Promise<PublicIntakePolicyDecision>;
+    deliver(input: {
+        source: string;
+        templateSlug: string;
+        policyDecisionId: string | null;
+        dedupeKey: string;
+        purpose: PublicIntakeDeliveryPurpose;
+        triggerEvent: string;
+        recipientEmail: string;
+        aggregateType: string;
+        aggregateId: string;
+        metadata?: Record<string, unknown>;
+        message: PublicIntakeDeliveryMessage;
+    }): Promise<PublicIntakeDeliveryResult>;
+}

package/dist/communications/contracts/publicIntake.js

@@ -0,0 +1 @@
+export {};

package/dist/communications/contracts/render.d.ts

@@ -0,0 +1,2 @@
+import type { EmailRenderer } from "./email.js";
+export declare const renderEmail: EmailRenderer;