@opencxh/domain 1.242.0 → 1.244.0

package/dist/entities/company/types.d.ts

@@ -1,3 +1,4 @@
+import { PostalAddress } from '../organization/types';
 import { OwnerScope } from '../scope/types';
 /** Where a company row came from. `local` is a row somebody created by hand. */
 export interface CompanySource {
@@ -39,6 +40,11 @@ export interface Company {
     externalIds: string[];
     ownerScope: OwnerScope;
     source: CompanySource;
+    /**
+     * Where the company sits. Needed by anything that puts this company on paper — a quote's
+     * recipient block is the first, and the issue gate refuses a document with a hole in it.
+     */
+    address?: PostalAddress;
     /** Raw, human-readable phone/website as entered, for display. */
     phone?: string;
     website?: string;

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;
+}

package/dist/entities/organization/types.d.ts

@@ -1,12 +1,18 @@
 import { OrganizationHouseStyle } from '../document-template/types';
 import { OrganizationProfile } from './profile';
-export interface OrganizationAddress {
+/**
+ * A postal address. One shape wherever one appears — the organisation's own and a customer's.
+ *
+ * A quote prints both, and two types that differ only by name is how the two sides drift apart.
+ */
+export interface PostalAddress {
     street?: string;
     houseNumber?: string;
     postalCode?: string;
     city?: string;
     country?: string;
 }
+export type OrganizationAddress = PostalAddress;
 export interface OrganizationBilling {
     companyName?: string;
     /** BTW / VAT number */

package/dist/entities/transaction/document.d.ts

@@ -1,6 +1,7 @@
 import { DocumentBlock } from '../../platform/document-blocks';
 import { DocumentSlots, TemplateContext } from '../document-template/tokens';
 import { TaxRate } from '../money/tax';
+import { PostalAddress } from '../organization/types';
 import { Transaction } from './types';
 /**
  * The seam between a transaction and the paper it is printed on.
@@ -16,8 +17,8 @@ import { Transaction } from './types';
 /** What a template author addresses. */
 export interface TransactionContextSources {
     companyName?: string;
-    /** `Company` carries no address today; the token exists so a template survives when it does. */
-    companyCity?: string;
+    /** The customer's postal address, for the recipient block. */
+    companyAddress?: PostalAddress;
     contactName?: string;
     organizationName?: string;
     /** Who the recipient reads; drives which template row is picked. */