@hartl-services/medusa-base 1.0.0 → 2.0.0

package/dist/documents/templates/packing-list.js

@@ -10,15 +10,15 @@ const renderBatchAllocations = (line, timeZone) => {
     return line.batch_allocations
         .map((allocation) => `<div class="packing-batch">
         <strong>${(0, html_utils_1.escapeHtml)(allocation.lot_number)}</strong>
-        <span>MHD: ${(0, format_1.formatDate)(allocation.expiry_date, { timeZone })}</span>
+        <span>MHD: ${(0, html_utils_1.escapeHtml)((0, format_1.formatDocumentDate)(allocation.expiry_date, timeZone))}</span>
         <span>Menge: ${(0, html_utils_1.escapeHtml)(allocation.quantity)}</span>
       </div>`)
         .join("");
 };
 const renderLines = (input, timeZone) => input.lines
     .map((line) => `<tr>
-        <td>
-          <strong>${(0, html_utils_1.escapeHtml)(line.title)}</strong>
+        <td class="item">
+          <div class="item-title">${(0, html_utils_1.escapeHtml)(line.title)}</div>
           ${line.sku ? `<div class="sku">SKU: ${(0, html_utils_1.escapeHtml)(line.sku)}</div>` : ""}
         </td>
         <td>${renderBatchAllocations(line, timeZone)}</td>
@@ -26,12 +26,13 @@ const renderLines = (input, timeZone) => input.lines
       </tr>`)
     .join("");
 const renderPackingList = (input, layout, timeZone) => layout({
-    body: `<table>
-      <thead><tr><th>Bezeichnung</th><th>Charge</th><th class="number">Benötigte Menge</th></tr></thead>
-      <tbody>${renderLines(input, timeZone)}</tbody>
+    body: `<table class="items packing-items">
+      <thead><tr><th class="item">Bezeichnung</th><th>Charge</th><th class="number">Benötigte Menge</th></tr></thead>
+      <tbody class="lines">${renderLines(input, timeZone)}</tbody>
     </table>`,
     documentTitle: "Packliste",
     metadata: [
+        { label: "Packlistennummer", value: input.document.number },
         {
             label: "Bestellung",
             value: (0, html_utils_1.formatOrderReference)(input.order.display_id),
@@ -39,11 +40,12 @@ const renderPackingList = (input, layout, timeZone) => layout({
         { label: "Fulfillment", value: input.fulfillment.id },
         {
             label: "Erstellungsdatum",
-            value: (0, format_1.formatDate)(input.document.generated_at, { timeZone }),
+            value: (0, format_1.formatDocumentDate)(input.document.generated_at, timeZone),
         },
         { label: "Lagerplatz", value: input.fulfillment.location_name },
     ],
     number: input.document.number,
     pageTitle: "Packliste",
+    recipient: null,
 });
 exports.renderPackingList = renderPackingList;

package/dist/documents/types/documents.d.ts

@@ -144,28 +144,23 @@ export type DocumentMerchant = {
     company_register_number: string | null;
     company_register_court: string | null;
 };
-/**
- * Optional `merchant` plugin option: used per field only where the shop
- * master data in the base plugin has no value (same shape as the demo shop's
- * `merchant` constant in medusa-config).
- */
-export type DocumentMerchantOption = {
-    countryCode: string;
-    legalName: string;
-    registeredAddress: {
-        address1: string;
-        address2?: string;
-        city: string;
-        countryCode: string;
-        postalCode: string;
-    };
-    vatNumber?: string;
+export type DocumentRenderSettings = {
+    /**
+     * The uploaded logo as a `data:` URL, ready for `<img src>`; `null` when no
+     * logo is set or it could not be loaded (the document then shows the
+     * merchant's legal name instead).
+     */
+    logo_src: string | null;
+    /** Payment terms printed below the totals of an invoice; `null` = none. */
+    payment_terms: string | null;
 };
 export type FinancialDocumentRenderInput = DocumentTemplateInput & {
     merchant: DocumentMerchant;
+    settings: DocumentRenderSettings;
 };
 export type PackingListRenderInput = PackingListTemplateInput & {
     merchant: DocumentMerchant;
+    settings: DocumentRenderSettings;
 };
 export type DocumentRenderInput = FinancialDocumentRenderInput | PackingListRenderInput;
 export type DocumentPdfOptions = {

package/dist/documents/types/html-factory.d.ts

@@ -5,3 +5,4 @@ import type { DocumentRenderInput } from "./documents";
  */
 export type DocumentHtmlFactory = (input: DocumentRenderInput) => string | Promise<string>;
 export declare const defineDocumentHtmlFactory: (factory: DocumentHtmlFactory) => DocumentHtmlFactory;
+export type { DocumentTheme } from "../templates/layout";

package/dist/email/types/shop-configuration.d.ts

@@ -1,3 +1,4 @@
+import type { ShopMasterData } from "../../public";
 import type { EmailKind } from "./email-kinds";
 import type { EmailRenderDataMap } from "./template-data";
 export type EmailTemplateContent = Readonly<{
@@ -5,10 +6,22 @@ export type EmailTemplateContent = Readonly<{
     subject: string;
     text: string;
 }>;
+/**
+ * The shop's master data ("Shop-Stammdaten") plus the `logo` URL of the
+ * E-Mail settings, read when the mail is sent. Every field may be missing; a
+ * layout shows what is there instead of failing.
+ */
+export type EmailShopDetails = Readonly<ShopMasterData & {
+    logo?: string;
+}>;
+/** Who reads a mail: a customer or the shop's own team. */
+export type EmailAudience = "customer" | "shop";
 export type EmailLayout = (input: Readonly<{
+    audience: EmailAudience;
     bodyHtml: string;
     preheader: string;
     subject: string;
+    shop: EmailShopDetails;
 }>) => string;
 export type EmailRendererMap = {
     readonly [Kind in EmailKind]: (data: EmailRenderDataMap[Kind]) => EmailTemplateContent;
@@ -19,6 +32,13 @@ export type EmailRendererMap = {
  * partial `renderers` map replaces only the listed kinds.
  */
 export type ShopEmailConfiguration = Readonly<{
+    /**
+     * Link to an order in the Medusa Admin; the shop's order notification shows
+     * an "Im Admin öffnen" button only when it is set.
+     */
+    adminOrderUrl?: (input: Readonly<{
+        orderId: string;
+    }>) => string;
     affiliatePortalUrl: string;
     displayName: string;
     inviteUrl: (input: Readonly<{
@@ -30,6 +50,11 @@ export type ShopEmailConfiguration = Readonly<{
         locale: string | null;
     }>) => string;
     renderers?: Partial<EmailRendererMap>;
+    /**
+     * IANA time zone of dates in the default templates (e.g. the order time in
+     * the shop's order notification); without it they are left out.
+     */
+    timeZone?: string;
 }>;
 /** A `ShopEmailConfiguration` with the defaults merged in; used internally. */
 export type ResolvedShopEmailConfiguration = Readonly<Omit<ShopEmailConfiguration, "layout" | "renderers"> & {