@aglyn/shared-util-email 1.0.0-beta.275 → 1.0.0-beta.282

package/src/lib/pos-hardware-emails.js

@@ -0,0 +1,310 @@
+/**
+ * @license
+ * Copyright 2026 Aglyn LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */ /*==========================================
+ * A CARD READER BOUGHT FROM THE PLATFORM, AS SYSTEM EMAILS (AGL-4038).
+ *
+ * The commerce plugin's POS hardware shop sends these to the person who
+ * placed the order: the order received, the parcel shipped with its
+ * tracking, and the parcel delivered with the way to set the reader up. The
+ * platform is the seller, so they are SYSTEM emails in the platform's brand
+ * (or the workspace's white label), not a store's own emails to its buyers.
+ *
+ * They live here, beside the catalog, for the reason `domain-emails.ts`
+ * gives: system emails have no plugin seam, and the staff System emails page
+ * reads this registry before any plugin loads.
+ *
+ * Amounts and dates arrive formatted; a template never does arithmetic.
+ *=========================================*/ export const POS_HARDWARE_EMAIL_KEYS = {
+    received: 'pos-hardware-order-received',
+    shipped: 'pos-hardware-order-shipped',
+    delivered: 'pos-hardware-order-delivered'
+};
+const SOURCE = 'libs/plugins/commerce/src/lib/server/pos-hardware-notify.ts';
+/**
+ * The sample site's Point of sale page in the console, for the designer's
+ * preview of the two links. It is a page a merchant opens, not a storage path,
+ * so it is written as one value rather than spelled out beside each link.
+ */ const SAMPLE_POS_PAGE = [
+    '/test-org',
+    'hosts',
+    'test-bakery',
+    'products',
+    'pos'
+].join('/');
+function tokens(origin) {
+    return {
+        org: {
+            name: 'org.name',
+            description: 'The workspace that placed the order',
+            sample: 'Test Org'
+        },
+        site: {
+            name: 'site.name',
+            description: 'The site the order was placed from',
+            sample: 'Test Bakery'
+        },
+        number: {
+            name: 'order.number',
+            description: 'The hardware order number',
+            sample: 'HW-3F9A21'
+        },
+        items: {
+            name: 'order.items',
+            description: 'What was ordered, one line per item',
+            sample: 'Stripe Reader S710 × 1\nCharging dock for the S700 and S710 × 1'
+        },
+        total: {
+            name: 'order.total',
+            description: 'What was charged, shipping and tax included',
+            sample: '$123.45'
+        },
+        shipTo: {
+            name: 'order.shipTo',
+            description: 'The name and address it ships to',
+            sample: 'Alex Test\n12 Main St\nSpringfield, IL 62701'
+        },
+        shipping: {
+            name: 'order.shippingMethod',
+            description: 'The shipping speed chosen',
+            sample: 'Standard shipping'
+        },
+        carrier: {
+            name: 'order.carrier',
+            description: 'The carrier delivering the parcel',
+            sample: 'UPS'
+        },
+        trackingNumber: {
+            name: 'order.trackingNumber',
+            description: 'The parcel’s tracking number',
+            sample: '1Z999AA10123456784'
+        },
+        trackingUrl: {
+            name: 'order.trackingUrl',
+            description: 'The carrier’s tracking page for the parcel',
+            sample: 'https://www.ups.com/track?tracknum=1Z999AA10123456784'
+        },
+        ordersUrl: {
+            name: 'order.ordersUrl',
+            description: 'The Hardware card, where the order and its status are',
+            sample: `${origin}${SAMPLE_POS_PAGE}#pos-hardware`
+        },
+        setupUrl: {
+            name: 'order.setupUrl',
+            description: 'The POS devices card, where a reader is added to a register',
+            sample: `${origin}${SAMPLE_POS_PAGE}#pos-devices`
+        }
+    };
+}
+export function posHardwareSystemEmailTemplates(origin) {
+    const t = tokens(origin);
+    const footer = 'You’re receiving this because you ordered card reader hardware for ' + '{{site.name}} from {{brand.productName}}.';
+    return [
+        {
+            key: POS_HARDWARE_EMAIL_KEYS.received,
+            name: 'Card reader order received',
+            description: 'Sent to the person who ordered card readers or accessories from the ' + 'POS hardware shop, once the payment goes through.',
+            deliveredBy: 'resend',
+            defaultSubject: 'We have your card reader order {{order.number}}',
+            mergeTokens: [
+                t.org,
+                t.site,
+                t.number,
+                t.items,
+                t.total,
+                t.shipTo,
+                t.shipping,
+                t.ordersUrl
+            ],
+            defaultBody: [
+                {
+                    block: 'text',
+                    text: '{{site.name}} · Order {{order.number}}',
+                    variant: 'eyebrow'
+                },
+                {
+                    block: 'text',
+                    text: 'Your hardware order is in',
+                    variant: 'heading'
+                },
+                {
+                    block: 'text',
+                    text: 'Thanks for your order. We place it with Stripe, which makes the readers and ships them straight to you. We will email you again with tracking as soon as it ships.',
+                    variant: 'body'
+                },
+                {
+                    block: 'text',
+                    text: '{{order.items}}\nShipping: {{order.shippingMethod}}\nTotal charged: {{order.total}}',
+                    variant: 'details'
+                },
+                {
+                    block: 'text',
+                    text: 'Shipping to',
+                    variant: 'subheading'
+                },
+                {
+                    block: 'text',
+                    text: '{{order.shipTo}}',
+                    variant: 'details'
+                },
+                {
+                    block: 'text',
+                    text: 'What happens next',
+                    variant: 'subheading'
+                },
+                {
+                    block: 'text',
+                    text: 'While the order is being prepared you can follow it on the Hardware card in your point of sale settings. If something is wrong with the address, contact support before it ships: {{brand.supportUrl}}',
+                    variant: 'body'
+                },
+                {
+                    block: 'button',
+                    label: 'See your order',
+                    href: '{{order.ordersUrl}}'
+                },
+                {
+                    block: 'text',
+                    text: 'Order {{order.number}} for {{org.name}}.',
+                    variant: 'caption'
+                }
+            ],
+            footerReason: footer,
+            source: SOURCE
+        },
+        {
+            key: POS_HARDWARE_EMAIL_KEYS.shipped,
+            name: 'Card reader order shipped',
+            description: 'Sent when a card reader order from the POS hardware shop ships, with ' + 'the carrier and a tracking link.',
+            deliveredBy: 'resend',
+            defaultSubject: 'Your card reader order {{order.number}} has shipped',
+            mergeTokens: [
+                t.org,
+                t.site,
+                t.number,
+                t.items,
+                t.shipTo,
+                t.carrier,
+                t.trackingNumber,
+                t.trackingUrl,
+                t.ordersUrl
+            ],
+            defaultBody: [
+                {
+                    block: 'text',
+                    text: '{{site.name}} · Order {{order.number}}',
+                    variant: 'eyebrow'
+                },
+                {
+                    block: 'text',
+                    text: 'Your hardware is on its way',
+                    variant: 'heading'
+                },
+                {
+                    block: 'text',
+                    text: 'Your order left Stripe’s warehouse and is with {{order.carrier}}. Someone may need to sign for it, so keep an eye on the tracking page for the delivery day.',
+                    variant: 'body'
+                },
+                {
+                    block: 'text',
+                    text: '{{order.items}}\nCarrier: {{order.carrier}}\nTracking number: {{order.trackingNumber}}',
+                    variant: 'details'
+                },
+                {
+                    block: 'button',
+                    label: 'Track your parcel',
+                    href: '{{order.trackingUrl}}'
+                },
+                {
+                    block: 'text',
+                    text: 'Before it arrives',
+                    variant: 'subheading'
+                },
+                {
+                    block: 'text',
+                    text: 'Pick the spot where the reader will live: it needs power and Wi-Fi, or a cellular signal for the S710. Once it is delivered, you add it to a register on the POS devices card in a minute.',
+                    variant: 'body'
+                },
+                {
+                    block: 'text',
+                    text: 'Shipping to: {{order.shipTo}}',
+                    variant: 'caption'
+                }
+            ],
+            footerReason: footer,
+            source: SOURCE
+        },
+        {
+            key: POS_HARDWARE_EMAIL_KEYS.delivered,
+            name: 'Card reader order delivered',
+            description: 'Sent when a card reader order from the POS hardware shop is delivered, ' + 'with the way to set the reader up at a register.',
+            deliveredBy: 'resend',
+            defaultSubject: 'Your card reader order {{order.number}} was delivered',
+            mergeTokens: [
+                t.org,
+                t.site,
+                t.number,
+                t.items,
+                t.setupUrl,
+                t.ordersUrl
+            ],
+            defaultBody: [
+                {
+                    block: 'text',
+                    text: '{{site.name}} · Order {{order.number}}',
+                    variant: 'eyebrow'
+                },
+                {
+                    block: 'text',
+                    text: 'Your hardware has arrived',
+                    variant: 'heading'
+                },
+                {
+                    block: 'text',
+                    text: 'Your order was delivered. Here is how to start taking payments with it.',
+                    variant: 'body'
+                },
+                {
+                    block: 'text',
+                    text: '{{order.items}}',
+                    variant: 'details'
+                },
+                {
+                    block: 'text',
+                    text: 'Set up your reader',
+                    variant: 'subheading'
+                },
+                {
+                    block: 'text',
+                    text: '1. Charge it and switch it on.\n2. Connect it to Wi-Fi from the reader’s Settings.\n3. On the reader, generate a pairing code.\n4. On the POS devices card, choose Add card reader and enter the code.',
+                    variant: 'details'
+                },
+                {
+                    block: 'button',
+                    label: 'Set up your reader',
+                    href: '{{order.setupUrl}}'
+                },
+                {
+                    block: 'text',
+                    text: 'The M2 pairs by Bluetooth from the {{brand.productName}} POS app instead. If anything arrived damaged, contact support: {{brand.supportUrl}}',
+                    variant: 'caption'
+                }
+            ],
+            footerReason: footer,
+            source: SOURCE
+        }
+    ];
+}
+
+//# sourceMappingURL=pos-hardware-emails.js.map

package/src/lib/pos-hardware-emails.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../../../libs/shared/util/email/src/lib/pos-hardware-emails.ts"],"sourcesContent":["/**\n * @license\n * Copyright 2026 Aglyn LLC\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *   http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n/*==========================================\n * A CARD READER BOUGHT FROM THE PLATFORM, AS SYSTEM EMAILS (AGL-4038).\n *\n * The commerce plugin's POS hardware shop sends these to the person who\n * placed the order: the order received, the parcel shipped with its\n * tracking, and the parcel delivered with the way to set the reader up. The\n * platform is the seller, so they are SYSTEM emails in the platform's brand\n * (or the workspace's white label), not a store's own emails to its buyers.\n *\n * They live here, beside the catalog, for the reason `domain-emails.ts`\n * gives: system emails have no plugin seam, and the staff System emails page\n * reads this registry before any plugin loads.\n *\n * Amounts and dates arrive formatted; a template never does arithmetic.\n *=========================================*/\n\nimport type {\n  SystemEmailMergeToken,\n  SystemEmailTemplateDefinition,\n} from './system-email-catalog'\n\nexport const POS_HARDWARE_EMAIL_KEYS = {\n  received: 'pos-hardware-order-received',\n  shipped: 'pos-hardware-order-shipped',\n  delivered: 'pos-hardware-order-delivered',\n} as const\n\nconst SOURCE = 'libs/plugins/commerce/src/lib/server/pos-hardware-notify.ts'\n\n/**\n * The sample site's Point of sale page in the console, for the designer's\n * preview of the two links. It is a page a merchant opens, not a storage path,\n * so it is written as one value rather than spelled out beside each link.\n */\nconst SAMPLE_POS_PAGE = ['/test-org', 'hosts', 'test-bakery', 'products', 'pos'].join('/')\n\nfunction tokens(origin: string): Record<string, SystemEmailMergeToken> {\n  return {\n    org: { name: 'org.name', description: 'The workspace that placed the order', sample: 'Test Org' },\n    site: { name: 'site.name', description: 'The site the order was placed from', sample: 'Test Bakery' },\n    number: { name: 'order.number', description: 'The hardware order number', sample: 'HW-3F9A21' },\n    items: {\n      name: 'order.items',\n      description: 'What was ordered, one line per item',\n      sample: 'Stripe Reader S710 × 1\\nCharging dock for the S700 and S710 × 1',\n    },\n    total: { name: 'order.total', description: 'What was charged, shipping and tax included', sample: '$123.45' },\n    shipTo: {\n      name: 'order.shipTo',\n      description: 'The name and address it ships to',\n      sample: 'Alex Test\\n12 Main St\\nSpringfield, IL 62701',\n    },\n    shipping: { name: 'order.shippingMethod', description: 'The shipping speed chosen', sample: 'Standard shipping' },\n    carrier: { name: 'order.carrier', description: 'The carrier delivering the parcel', sample: 'UPS' },\n    trackingNumber: { name: 'order.trackingNumber', description: 'The parcel’s tracking number', sample: '1Z999AA10123456784' },\n    trackingUrl: {\n      name: 'order.trackingUrl',\n      description: 'The carrier’s tracking page for the parcel',\n      sample: 'https://www.ups.com/track?tracknum=1Z999AA10123456784',\n    },\n    ordersUrl: {\n      name: 'order.ordersUrl',\n      description: 'The Hardware card, where the order and its status are',\n      sample: `${origin}${SAMPLE_POS_PAGE}#pos-hardware`,\n    },\n    setupUrl: {\n      name: 'order.setupUrl',\n      description: 'The POS devices card, where a reader is added to a register',\n      sample: `${origin}${SAMPLE_POS_PAGE}#pos-devices`,\n    },\n  }\n}\n\nexport function posHardwareSystemEmailTemplates(\n  origin: string,\n): SystemEmailTemplateDefinition[] {\n  const t = tokens(origin)\n  const footer =\n    'You’re receiving this because you ordered card reader hardware for ' +\n    '{{site.name}} from {{brand.productName}}.'\n  return [\n    {\n      key: POS_HARDWARE_EMAIL_KEYS.received,\n      name: 'Card reader order received',\n      description:\n        'Sent to the person who ordered card readers or accessories from the ' +\n        'POS hardware shop, once the payment goes through.',\n      deliveredBy: 'resend',\n      defaultSubject: 'We have your card reader order {{order.number}}',\n      mergeTokens: [t.org, t.site, t.number, t.items, t.total, t.shipTo, t.shipping, t.ordersUrl],\n      defaultBody: [\n        { block: 'text', text: '{{site.name}} · Order {{order.number}}', variant: 'eyebrow' },\n        { block: 'text', text: 'Your hardware order is in', variant: 'heading' },\n        { block: 'text', text: 'Thanks for your order. We place it with Stripe, which makes the readers and ships them straight to you. We will email you again with tracking as soon as it ships.', variant: 'body' },\n        { block: 'text', text: '{{order.items}}\\nShipping: {{order.shippingMethod}}\\nTotal charged: {{order.total}}', variant: 'details' },\n        { block: 'text', text: 'Shipping to', variant: 'subheading' },\n        { block: 'text', text: '{{order.shipTo}}', variant: 'details' },\n        { block: 'text', text: 'What happens next', variant: 'subheading' },\n        { block: 'text', text: 'While the order is being prepared you can follow it on the Hardware card in your point of sale settings. If something is wrong with the address, contact support before it ships: {{brand.supportUrl}}', variant: 'body' },\n        { block: 'button', label: 'See your order', href: '{{order.ordersUrl}}' },\n        { block: 'text', text: 'Order {{order.number}} for {{org.name}}.', variant: 'caption' },\n      ],\n      footerReason: footer,\n      source: SOURCE,\n    },\n    {\n      key: POS_HARDWARE_EMAIL_KEYS.shipped,\n      name: 'Card reader order shipped',\n      description:\n        'Sent when a card reader order from the POS hardware shop ships, with ' +\n        'the carrier and a tracking link.',\n      deliveredBy: 'resend',\n      defaultSubject: 'Your card reader order {{order.number}} has shipped',\n      mergeTokens: [\n        t.org, t.site, t.number, t.items, t.shipTo, t.carrier, t.trackingNumber, t.trackingUrl, t.ordersUrl,\n      ],\n      defaultBody: [\n        { block: 'text', text: '{{site.name}} · Order {{order.number}}', variant: 'eyebrow' },\n        { block: 'text', text: 'Your hardware is on its way', variant: 'heading' },\n        { block: 'text', text: 'Your order left Stripe’s warehouse and is with {{order.carrier}}. Someone may need to sign for it, so keep an eye on the tracking page for the delivery day.', variant: 'body' },\n        { block: 'text', text: '{{order.items}}\\nCarrier: {{order.carrier}}\\nTracking number: {{order.trackingNumber}}', variant: 'details' },\n        { block: 'button', label: 'Track your parcel', href: '{{order.trackingUrl}}' },\n        { block: 'text', text: 'Before it arrives', variant: 'subheading' },\n        { block: 'text', text: 'Pick the spot where the reader will live: it needs power and Wi-Fi, or a cellular signal for the S710. Once it is delivered, you add it to a register on the POS devices card in a minute.', variant: 'body' },\n        { block: 'text', text: 'Shipping to: {{order.shipTo}}', variant: 'caption' },\n      ],\n      footerReason: footer,\n      source: SOURCE,\n    },\n    {\n      key: POS_HARDWARE_EMAIL_KEYS.delivered,\n      name: 'Card reader order delivered',\n      description:\n        'Sent when a card reader order from the POS hardware shop is delivered, ' +\n        'with the way to set the reader up at a register.',\n      deliveredBy: 'resend',\n      defaultSubject: 'Your card reader order {{order.number}} was delivered',\n      mergeTokens: [t.org, t.site, t.number, t.items, t.setupUrl, t.ordersUrl],\n      defaultBody: [\n        { block: 'text', text: '{{site.name}} · Order {{order.number}}', variant: 'eyebrow' },\n        { block: 'text', text: 'Your hardware has arrived', variant: 'heading' },\n        { block: 'text', text: 'Your order was delivered. Here is how to start taking payments with it.', variant: 'body' },\n        { block: 'text', text: '{{order.items}}', variant: 'details' },\n        { block: 'text', text: 'Set up your reader', variant: 'subheading' },\n        { block: 'text', text: '1. Charge it and switch it on.\\n2. Connect it to Wi-Fi from the reader’s Settings.\\n3. On the reader, generate a pairing code.\\n4. On the POS devices card, choose Add card reader and enter the code.', variant: 'details' },\n        { block: 'button', label: 'Set up your reader', href: '{{order.setupUrl}}' },\n        { block: 'text', text: 'The M2 pairs by Bluetooth from the {{brand.productName}} POS app instead. If anything arrived damaged, contact support: {{brand.supportUrl}}', variant: 'caption' },\n      ],\n      footerReason: footer,\n      source: SOURCE,\n    },\n  ]\n}\n"],"names":["POS_HARDWARE_EMAIL_KEYS","received","shipped","delivered","SOURCE","SAMPLE_POS_PAGE","join","tokens","origin","org","name","description","sample","site","number","items","total","shipTo","shipping","carrier","trackingNumber","trackingUrl","ordersUrl","setupUrl","posHardwareSystemEmailTemplates","t","footer","key","deliveredBy","defaultSubject","mergeTokens","defaultBody","block","text","variant","label","href","footerReason","source"],"mappings":"AAAA;;;;;;;;;;;;;;;CAeC,GAED;;;;;;;;;;;;;;2CAc2C,GAO3C,OAAO,MAAMA,0BAA0B;IACrCC,UAAU;IACVC,SAAS;IACTC,WAAW;AACb,EAAU;AAEV,MAAMC,SAAS;AAEf;;;;CAIC,GACD,MAAMC,kBAAkB;IAAC;IAAa;IAAS;IAAe;IAAY;CAAM,CAACC,IAAI,CAAC;AAEtF,SAASC,OAAOC,MAAc;IAC5B,OAAO;QACLC,KAAK;YAAEC,MAAM;YAAYC,aAAa;YAAuCC,QAAQ;QAAW;QAChGC,MAAM;YAAEH,MAAM;YAAaC,aAAa;YAAsCC,QAAQ;QAAc;QACpGE,QAAQ;YAAEJ,MAAM;YAAgBC,aAAa;YAA6BC,QAAQ;QAAY;QAC9FG,OAAO;YACLL,MAAM;YACNC,aAAa;YACbC,QAAQ;QACV;QACAI,OAAO;YAAEN,MAAM;YAAeC,aAAa;YAA+CC,QAAQ;QAAU;QAC5GK,QAAQ;YACNP,MAAM;YACNC,aAAa;YACbC,QAAQ;QACV;QACAM,UAAU;YAAER,MAAM;YAAwBC,aAAa;YAA6BC,QAAQ;QAAoB;QAChHO,SAAS;YAAET,MAAM;YAAiBC,aAAa;YAAqCC,QAAQ;QAAM;QAClGQ,gBAAgB;YAAEV,MAAM;YAAwBC,aAAa;YAAgCC,QAAQ;QAAqB;QAC1HS,aAAa;YACXX,MAAM;YACNC,aAAa;YACbC,QAAQ;QACV;QACAU,WAAW;YACTZ,MAAM;YACNC,aAAa;YACbC,QAAQ,GAAGJ,SAASH,gBAAgB,aAAa,CAAC;QACpD;QACAkB,UAAU;YACRb,MAAM;YACNC,aAAa;YACbC,QAAQ,GAAGJ,SAASH,gBAAgB,YAAY,CAAC;QACnD;IACF;AACF;AAEA,OAAO,SAASmB,gCACdhB,MAAc;IAEd,MAAMiB,IAAIlB,OAAOC;IACjB,MAAMkB,SACJ,wEACA;IACF,OAAO;QACL;YACEC,KAAK3B,wBAAwBC,QAAQ;YACrCS,MAAM;YACNC,aACE,yEACA;YACFiB,aAAa;YACbC,gBAAgB;YAChBC,aAAa;gBAACL,EAAEhB,GAAG;gBAAEgB,EAAEZ,IAAI;gBAAEY,EAAEX,MAAM;gBAAEW,EAAEV,KAAK;gBAAEU,EAAET,KAAK;gBAAES,EAAER,MAAM;gBAAEQ,EAAEP,QAAQ;gBAAEO,EAAEH,SAAS;aAAC;YAC3FS,aAAa;gBACX;oBAAEC,OAAO;oBAAQC,MAAM;oBAA0CC,SAAS;gBAAU;gBACpF;oBAAEF,OAAO;oBAAQC,MAAM;oBAA6BC,SAAS;gBAAU;gBACvE;oBAAEF,OAAO;oBAAQC,MAAM;oBAAsKC,SAAS;gBAAO;gBAC7M;oBAAEF,OAAO;oBAAQC,MAAM;oBAAuFC,SAAS;gBAAU;gBACjI;oBAAEF,OAAO;oBAAQC,MAAM;oBAAeC,SAAS;gBAAa;gBAC5D;oBAAEF,OAAO;oBAAQC,MAAM;oBAAoBC,SAAS;gBAAU;gBAC9D;oBAAEF,OAAO;oBAAQC,MAAM;oBAAqBC,SAAS;gBAAa;gBAClE;oBAAEF,OAAO;oBAAQC,MAAM;oBAA0MC,SAAS;gBAAO;gBACjP;oBAAEF,OAAO;oBAAUG,OAAO;oBAAkBC,MAAM;gBAAsB;gBACxE;oBAAEJ,OAAO;oBAAQC,MAAM;oBAA4CC,SAAS;gBAAU;aACvF;YACDG,cAAcX;YACdY,QAAQlC;QACV;QACA;YACEuB,KAAK3B,wBAAwBE,OAAO;YACpCQ,MAAM;YACNC,aACE,0EACA;YACFiB,aAAa;YACbC,gBAAgB;YAChBC,aAAa;gBACXL,EAAEhB,GAAG;gBAAEgB,EAAEZ,IAAI;gBAAEY,EAAEX,MAAM;gBAAEW,EAAEV,KAAK;gBAAEU,EAAER,MAAM;gBAAEQ,EAAEN,OAAO;gBAAEM,EAAEL,cAAc;gBAAEK,EAAEJ,WAAW;gBAAEI,EAAEH,SAAS;aACpG;YACDS,aAAa;gBACX;oBAAEC,OAAO;oBAAQC,MAAM;oBAA0CC,SAAS;gBAAU;gBACpF;oBAAEF,OAAO;oBAAQC,MAAM;oBAA+BC,SAAS;gBAAU;gBACzE;oBAAEF,OAAO;oBAAQC,MAAM;oBAAgKC,SAAS;gBAAO;gBACvM;oBAAEF,OAAO;oBAAQC,MAAM;oBAA0FC,SAAS;gBAAU;gBACpI;oBAAEF,OAAO;oBAAUG,OAAO;oBAAqBC,MAAM;gBAAwB;gBAC7E;oBAAEJ,OAAO;oBAAQC,MAAM;oBAAqBC,SAAS;gBAAa;gBAClE;oBAAEF,OAAO;oBAAQC,MAAM;oBAA8LC,SAAS;gBAAO;gBACrO;oBAAEF,OAAO;oBAAQC,MAAM;oBAAiCC,SAAS;gBAAU;aAC5E;YACDG,cAAcX;YACdY,QAAQlC;QACV;QACA;YACEuB,KAAK3B,wBAAwBG,SAAS;YACtCO,MAAM;YACNC,aACE,4EACA;YACFiB,aAAa;YACbC,gBAAgB;YAChBC,aAAa;gBAACL,EAAEhB,GAAG;gBAAEgB,EAAEZ,IAAI;gBAAEY,EAAEX,MAAM;gBAAEW,EAAEV,KAAK;gBAAEU,EAAEF,QAAQ;gBAAEE,EAAEH,SAAS;aAAC;YACxES,aAAa;gBACX;oBAAEC,OAAO;oBAAQC,MAAM;oBAA0CC,SAAS;gBAAU;gBACpF;oBAAEF,OAAO;oBAAQC,MAAM;oBAA6BC,SAAS;gBAAU;gBACvE;oBAAEF,OAAO;oBAAQC,MAAM;oBAA2EC,SAAS;gBAAO;gBAClH;oBAAEF,OAAO;oBAAQC,MAAM;oBAAmBC,SAAS;gBAAU;gBAC7D;oBAAEF,OAAO;oBAAQC,MAAM;oBAAsBC,SAAS;gBAAa;gBACnE;oBAAEF,OAAO;oBAAQC,MAAM;oBAA0MC,SAAS;gBAAU;gBACpP;oBAAEF,OAAO;oBAAUG,OAAO;oBAAsBC,MAAM;gBAAqB;gBAC3E;oBAAEJ,OAAO;oBAAQC,MAAM;oBAAgJC,SAAS;gBAAU;aAC3L;YACDG,cAAcX;YACdY,QAAQlC;QACV;KACD;AACH"}

package/src/lib/send-email.d.ts

@@ -36,6 +36,30 @@ export interface EmailTag {
     name: string;
     value: string;
 }
+/**
+ * A file carried with a message (AGL-4042): a signed waiver's PDF, say.
+ * `content` is the file's bytes in base64. Bounded by
+ * {@link EMAIL_ATTACHMENT_LIMITS}, and refused on a marketing send, which is
+ * mail to a list and never a document owed to one person.
+ */
+export interface EmailAttachment {
+    filename: string;
+    contentType: string;
+    content: string;
+}
+export declare const EMAIL_ATTACHMENT_LIMITS: {
+    readonly count: 5;
+    /** The base64 characters across every attachment of one message. */
+    readonly totalBase64Chars: number;
+};
+/** The attachments a caller passed, or the reason they cannot ride. */
+export declare function checkEmailAttachments(attachments: readonly EmailAttachment[] | undefined): {
+    ok: true;
+    attachments: EmailAttachment[];
+} | {
+    ok: false;
+    detail: string;
+};
 export interface SendEmailOptions {
     /** One or more recipient addresses. */
     to: string | string[];
@@ -64,6 +88,8 @@ export interface SendEmailOptions {
      * `to` recipients, so a marketing send refuses any.
      */
     bcc?: string | string[];
+    /** Files carried with the message (AGL-4042); see {@link EmailAttachment}. */
+    attachments?: EmailAttachment[];
     /**
      * White-label display name for the sender (White-Label Phase 1). Replaces
      * only the display name in front of the verified address — the address
@@ -438,6 +464,11 @@ export interface EmailConfig {
  * long before the runtime env exists.
  */
 export declare function getEmailConfig(): EmailConfig;
+/**
+ * Where a reply to the platform's own mail goes: the operator's support
+ * mailbox, `NEXT_PUBLIC_OPERATOR_SUPPORT_EMAIL`, or nothing when it is unset.
+ */
+export declare function platformReplyTo(): string | undefined;
 /**
  * True when the provider has its settings and `USAGE_EMAIL_FROM` is present.
  *

package/src/lib/send-email.js

@@ -32,6 +32,55 @@ import { bareSenderAddress } from "./email-delivery-events.js";
 import { screenTenantMessage } from "./outbound-screen-gate.js";
 import { providerRetryAtMs } from "./mail-provider.js";
 import { mailProvider, mailProviderProblem } from "./mail-providers.js";
+export const EMAIL_ATTACHMENT_LIMITS = {
+    count: 5,
+    /** The base64 characters across every attachment of one message. */ totalBase64Chars: 10 * 1024 * 1024
+};
+/** The attachments a caller passed, or the reason they cannot ride. */ export function checkEmailAttachments(attachments) {
+    const list = (attachments != null ? attachments : []).filter(Boolean);
+    if (list.length > EMAIL_ATTACHMENT_LIMITS.count) {
+        return {
+            ok: false,
+            detail: `A message carries at most ${EMAIL_ATTACHMENT_LIMITS.count} attachments.`
+        };
+    }
+    let total = 0;
+    for (const attachment of list){
+        var _attachment_filename, _attachment_contentType, _attachment_content;
+        const filename = String((_attachment_filename = attachment.filename) != null ? _attachment_filename : '').trim();
+        if (!filename || /[\\/\r\n]/.test(filename)) {
+            return {
+                ok: false,
+                detail: 'An attachment needs a plain file name.'
+            };
+        }
+        if (!/^[\w.+-]+\/[\w.+-]+$/.test(String((_attachment_contentType = attachment.contentType) != null ? _attachment_contentType : ''))) {
+            return {
+                ok: false,
+                detail: `The attachment ${filename} has no content type.`
+            };
+        }
+        if (!/^[A-Za-z0-9+/]+={0,2}$/.test(String((_attachment_content = attachment.content) != null ? _attachment_content : ''))) {
+            return {
+                ok: false,
+                detail: `The attachment ${filename} is not base64.`
+            };
+        }
+        total += attachment.content.length;
+    }
+    if (total > EMAIL_ATTACHMENT_LIMITS.totalBase64Chars) {
+        return {
+            ok: false,
+            detail: 'The attachments are too large to send.'
+        };
+    }
+    return {
+        ok: true,
+        attachments: list.map((one)=>_extends({}, one, {
+                filename: one.filename.trim()
+            }))
+    };
+}
 /**
  * The `context` tag, attached to every send (AGL-2407).
  *
@@ -235,6 +284,12 @@ import { mailProvider, mailProviderProblem } from "./mail-providers.js";
         from: process.env.USAGE_EMAIL_FROM || undefined
     };
 }
+/**
+ * Where a reply to the platform's own mail goes: the operator's support
+ * mailbox, `NEXT_PUBLIC_OPERATOR_SUPPORT_EMAIL`, or nothing when it is unset.
+ */ export function platformReplyTo() {
+    return (process.env.NEXT_PUBLIC_OPERATOR_SUPPORT_EMAIL || '').trim() || undefined;
+}
 /**
  * True when the provider has its settings and `USAGE_EMAIL_FROM` is present.
  *
@@ -280,7 +335,7 @@ function normalizeRecipients(to) {
  * `{ sent: false, reason: 'unconfigured' }` rather than failing, so local and
  * preview environments keep working without a mail provider.
  */ export async function sendEmail(options) {
-    var _ref, _ref1, _ref2, _ref3, _ref4, _options_bcc, _options_text;
+    var _ref, _options_replyTo, _ref1, _ref2, _ref3, _ref4, _options_bcc, _options_text;
     var _options_sendingIdentity, _options_sendingIdentity1, _options_marketing, _preflight_refused, _preflight_held, _options_marketing1, _options_marketing2, _options_headers;
     const provider = mailProvider();
     const configuredFrom = process.env.USAGE_EMAIL_FROM || undefined;
@@ -338,6 +393,12 @@ function normalizeRecipients(to) {
         };
     }
     const from = applyFromName(resolvedFrom != null ? resolvedFrom : configuredFrom, messageFromName(options));
+    // Platform mail answers to the operator's support mailbox. The sending
+    // subdomain has no inbox, so without this a reply to an account, billing
+    // or team email went nowhere, and the From had to say "noreply" to admit
+    // it. A message on a resolved identity (a site's own address) keeps
+    // whatever its caller set; so does any caller that names its own.
+    const replyTo = (_options_replyTo = options.replyTo) != null ? _options_replyTo : resolvedFrom ? undefined : platformReplyTo();
     const missing = [
         ...provider.missingSettings(),
         ...from ? [] : [
@@ -466,8 +527,25 @@ function normalizeRecipients(to) {
    * gate minted the pair.
    */ let unsubscribeUrl = (_ref3 = (_options_marketing1 = options.marketing) == null ? void 0 : _options_marketing1.unsubscribeUrl) != null ? _ref3 : '';
     let oneClickUrl = (_ref4 = (_options_marketing2 = options.marketing) == null ? void 0 : _options_marketing2.oneClickUrl) != null ? _ref4 : '';
+    const attached = checkEmailAttachments(options.attachments);
+    if (attached.ok === false) {
+        console.error(`${label} refused — ${attached.detail}`);
+        return {
+            sent: false,
+            reason: 'no-recipient',
+            detail: attached.detail
+        };
+    }
     if (options.marketing) {
         var _options_bcc1;
+        if (attached.attachments.length) {
+            console.error(`${label} refused — a marketing send carries no attachments`);
+            return {
+                sent: false,
+                reason: 'no-recipient',
+                detail: 'A marketing send carries no attachments.'
+            };
+        }
         if (normalizeRecipients((_options_bcc1 = options.bcc) != null ? _options_bcc1 : []).length) {
             // A blind copy of a marketing send is mail the gate never asked about.
             console.error(`${label} refused — a marketing send carries no blind copies`);
@@ -681,10 +759,12 @@ function normalizeRecipients(to) {
             headers
         } : {}, tags.length ? {
             tags
-        } : {}, options.replyTo ? {
-            replyTo: options.replyTo
+        } : {}, replyTo ? {
+            replyTo
         } : {}, bcc.length ? {
             bcc
+        } : {}, attached.attachments.length ? {
+            attachments: attached.attachments
         } : {}), options.context);
         if (!outcome.accepted) {
             var _refusal_detail;