@opencxh/domain 1.241.0 → 1.242.0

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

@@ -33,7 +33,7 @@ export type DocumentSlots = Record<string, readonly DocumentBlock[]>;
  * text lives.
  *
  * Every text-bearing field is walked, not just `text` — a token in a table cell or a letterhead
- * value is the ordinary case for an invoice, and missing one would leave `{factuur.nummer}`
+ * value is the ordinary case for an invoice, and missing one would leave `{invoice.number}`
  * printed on a document that went out the door.
  */
 export declare function fillDocument(blocks: readonly DocumentBlock[], context: TemplateContext, conditions?: Record<string, TemplateCondition>, slots?: DocumentSlots): FillDocumentResult;

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

@@ -59,7 +59,7 @@ export interface DocumentTemplate {
  * app that decides it.
  */
 export interface TemplateCondition {
-    /** A path into the same context the tokens read: `klant.incasso`. */
+    /** A path into the same context the tokens read: `customer.direct_debit`. */
     key: string;
     /** Show when the value equals this. */
     equals?: unknown;

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

@@ -0,0 +1,71 @@
+import { DocumentBlock } from '../../platform/document-blocks';
+import { DocumentSlots, TemplateContext } from '../document-template/tokens';
+import { TaxRate } from '../money/tax';
+import { Transaction } from './types';
+/**
+ * The seam between a transaction and the paper it is printed on.
+ *
+ * Two functions and no renderer. The block order lives in a `DocumentTemplate` row, not in code:
+ * the moment it is hardcoded here, the template layer is decoration and every house-style change
+ * is a deploy. What a template *cannot* express is the line table and the totals — a token
+ * replaces text, it cannot build a table out of an array — so those arrive as slots.
+ *
+ * The consequence for a second consumer (a work order, a timesheet) is that it costs one context,
+ * one slot function and one seeded template row. No renderer, no screen, no export.
+ */
+/** 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;
+    contactName?: string;
+    organizationName?: string;
+    /** Who the recipient reads; drives which template row is picked. */
+    locale?: string;
+}
+/**
+ * The tokens: `{customer.name}`, `{quote.number}`, `{totals.gross}`.
+ *
+ * English, like every other identifier in this repo. A token is a **path into data**, not a
+ * sentence — the Dutch on a quote is the text a template author writes around it.
+ *
+ * **The cost price and the margin are not in here, and that is load-bearing.** A template author
+ * writes `{regel.bedrag}` by hand; if a cost ever landed in this object, `{regel.inkoop}` on a
+ * quote would be one typo away from the customer. The shield on the way out of the server
+ * (`transactionView`) is the second lock; this one is the first.
+ */
+export declare function transactionContext(transaction: Transaction, sources?: TransactionContextSources): TemplateContext;
+/**
+ * The blocks a template cannot write itself: the line table and the totals.
+ *
+ * Keyed by the `block_id` the template author puts on an empty placeholder — `lines` and `totals`.
+ * That pairing is a **convention**, not a contract: an author cannot invent a third slot and
+ * expect sales to fill it, because the consumer decides what it hands over.
+ *
+ * Amounts arrive already formatted. The blocks layer never computes; that is the whole reason a
+ * totals row carries a string.
+ */
+export declare function transactionSlots(transaction: Transaction, rates?: readonly TaxRate[], labels?: SlotLabels): DocumentSlots;
+export interface SlotLabels {
+    description: string;
+    quantity: string;
+    unitPrice: string;
+    net: string;
+    tax: string;
+    gross: string;
+}
+export declare const DUTCH_SLOT_LABELS: SlotLabels;
+/**
+ * The default quote template, as a **seed** — not a renderer.
+ *
+ * Note the split inside it: the token **paths** are English because they address data, the
+ * **text** around them is Dutch because a customer reads it.
+ *
+ * The distinction is the whole point of the template layer: this array is written into a
+ * `DocumentTemplate` row the first time an organisation needs one, and from then on the row is
+ * the truth. An administrator moves the terms above the lines and that sticks; nobody deploys.
+ *
+ * The two empty placeholders are the slots {@link transactionSlots} fills. Their `block_id` is
+ * the whole contract.
+ */
+export declare const DEFAULT_QUOTE_TEMPLATE_BLOCKS: DocumentBlock[];

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

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

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

@@ -1,4 +1,5 @@
 export * from './convert';
+export * from './document';
 export * from './keys';
 export * from './kinds';
 export * from './types';