@opencxh/domain 1.243.0 → 1.244.0

package/dist/entities/document-template/sender.test.d.ts

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

package/dist/entities/document-template/types.d.ts

@@ -1,4 +1,5 @@
 import { DocumentBlock } from '../../platform/document-blocks';
+import { PostalAddress } from '../organization/types';
 /**
  * A document template: the blocks a generated document is built from.
  *
@@ -85,3 +86,44 @@ export interface OrganizationHouseStyle {
      */
     iban?: string;
 }
+/**
+ * The sender, as a document shows it: the organisation's own details, already turned into lines.
+ *
+ * Drawn **around** a document rather than written into it — the reason `DocumentBlock` has no
+ * sender block. It is computed on the server so the print, the preview and whatever mails a PDF
+ * one day all show the same letterhead, and so the renderer needs to know nothing about
+ * `Organization`.
+ */
+export interface DocumentSender {
+    name: string;
+    /** Street, postcode + city, country — only the lines that exist. */
+    addressLines: string[];
+    /** KvK, VAT, IBAN, plus the organisation's own footer sentence. Only what is filled in. */
+    footerLines: string[];
+    /** Inline data-URI; there is no publicly readable URL for an uploaded file. */
+    logo?: string;
+}
+/**
+ * An organisation's details as a letterhead.
+ *
+ * Every field is optional on `Organization`, so every line here is conditional: a half-filled
+ * organisation gets a short letterhead, never `undefined, undefined`. The billing name wins over
+ * the display name — what is on a quote is the legal entity.
+ */
+export declare function organizationSender(organization: OrganizationLike | null | undefined): DocumentSender;
+/**
+ * What {@link organizationSender} reads. Structural rather than `Organization` itself, so this
+ * file keeps pointing at the organisation entity instead of the other way round.
+ */
+export interface OrganizationLike {
+    name?: string;
+    displayName?: string;
+    logo?: string;
+    address?: PostalAddress;
+    billing?: {
+        companyName?: string;
+        vatNumber?: string;
+        kvkNumber?: string;
+    };
+    houseStyle?: OrganizationHouseStyle;
+}