@diy-accounting-uk/diya-gl 1.2.56 → 1.2.58

package/README.md

@@ -96,8 +96,9 @@ Each subcommand is also its own command, if you only want one on your `PATH`:
 
 ## API
 
-The package root exports three functions that turn a book into the figures HMRC's MTD APIs
-take. Each takes the parsed book, its lines and a parameters object, and returns a promise.
+The package root exports five functions that turn a book into the figures HMRC's MTD APIs
+take. Each takes the parsed book, its lines and a parameters object. The VAT and self-employment
+functions return a promise; the two UK property functions return their answer directly.
 Nothing is sent anywhere: the answer is the request body to send, plus what fed it.
 
 Load a book first:
@@ -166,6 +167,36 @@ const answer = await deriveItsaAnnualSubmission(book, lines, { taxYear: "2025-26
 console.log(answer.allowances.annualInvestmentAllowance);
 ```
 
+### `deriveUkPropertyPeriod(book, lines, { periodStartDate, periodEndDate })`
+
+One period of HMRC's Property Business API (UK property) from a sole trader book. The book's
+chart names the HMRC field each account feeds with `diya-gl:ukPropertyField` on the account
+(for example `"income.periodAmount"` on the rent account, `"expenses.repairsAndMaintenance"` on
+the repairs account). The function sums the sales and purchases postings on those accounts
+between the two dates inclusive, net of VAT, with a credit note taking from its field. The
+answer carries `income`, `expenses`, `omitted` (the fields no posting fed; they are left out of
+the body, never sent as zero), `lines` and `warnings`. A book that names
+`expenses.consolidatedExpenses` and an itemised expense in the same period is refused, because
+HMRC takes one or the other.
+
+```js
+import { deriveUkPropertyPeriod } from "@diy-accounting-uk/diya-gl";
+
+const { book, lines } = loadBook("my-landlord-book");
+const answer = deriveUkPropertyPeriod(book, lines, { periodStartDate: "2025-04-06", periodEndDate: "2025-07-05" });
+console.log(answer.income.periodAmount, answer.expenses.repairsAndMaintenance);
+```
+
+### `deriveUkPropertyAnnual(book, lines, { taxYear? })`
+
+The year's adjustments (`balancingCharge`, `privateUseAdjustment`,
+`businessPremisesRenovationAllowanceBalancingCharges`) and allowances (`annualInvestmentAllowance`,
+`businessPremisesRenovationAllowance`, `otherCapitalAllowance`, `costOfReplacingDomesticItems`,
+`zeroEmissionsCarAllowance`) from the postings on the accounts the chart names, for the tax year
+`taxYear` (as `2025-26`; the default is the year the book's period end falls in). The property
+income allowance, `nonResidentLandlord` and `rentARoom.jointlyLet` are choices and facts about the
+landlord, not ledger figures; the answer lists them under `leftToPage`.
+
 ## The format
 
 A diya-gl book's fields are drawn from the XBRL Global Ledger Taxonomy Framework 2015 and

package/dist/app/bin/export.js

@@ -60,6 +60,7 @@ import {
   PackagePartError,
   ProductNotAvailableError,
 } from "../lib/diya-gl-interchange.js";
+import { frcSuiteConcepts } from "../lib/frc-suite-concepts-node.js";
 import { PRODUCTS } from "../lib/products.js";
 
 // A book read through --file whose sniffed product disagrees with the
@@ -216,7 +217,12 @@ async function writeBookChecksJson(outputDir, book, lines) {
 export async function extractBookFromFile(filePath, { product } = {}) {
   const resolvedFile = resolve(filePath);
   const bytes = readFileSync(resolvedFile);
-  const { product: sniffedProduct, book, lines, overtyped } = await readBookSource(bytes, basename(resolvedFile), { products: PRODUCTS });
+  const {
+    product: sniffedProduct,
+    book,
+    lines,
+    overtyped,
+  } = await readBookSource(bytes, basename(resolvedFile), { products: PRODUCTS, suiteConcepts: frcSuiteConcepts });
   if (product && product !== sniffedProduct) {
     throw new PackageMismatchError(product, PRODUCTS[sniffedProduct].PRODUCT.name);
   }

package/dist/app/bin/link.js

@@ -19,6 +19,7 @@ import { join, resolve } from "path";
 import { fileURLToPath } from "url";
 import { parseDiyaGlData } from "../lib/diya-gl-loader.js";
 import { readBookSource } from "../lib/diya-gl-interchange.js";
+import { frcSuiteConcepts } from "../lib/frc-suite-concepts-node.js";
 import { canonicalBookToml, canonicalLinesJsonl } from "../lib/diya-gl-canonical.js";
 import { productIdOf } from "../lib/xlsx-exporter.js";
 import { PRODUCTS } from "../lib/products.js";
@@ -51,7 +52,7 @@ async function readBookText(source) {
     const lines = readFileSync(join(path, "lines.jsonl"), "utf8");
     return { toml, lines, book: parseDiyaGlData(toml, lines).book };
   }
-  const { book, lines } = await readBookSource(readFileSync(path), source, { products: PRODUCTS });
+  const { book, lines } = await readBookSource(readFileSync(path), source, { products: PRODUCTS, suiteConcepts: frcSuiteConcepts });
   return { toml: canonicalBookToml(book), lines: canonicalLinesJsonl(lines), book };
 }
 

package/dist/app/bin/roll-forward.js

@@ -22,6 +22,7 @@ import { join, resolve } from "path";
 import { fileURLToPath } from "url";
 import { parseDiyaGlData } from "../lib/diya-gl-loader.js";
 import { readBookSource } from "../lib/diya-gl-interchange.js";
+import { frcSuiteConcepts } from "../lib/frc-suite-concepts-node.js";
 import { PRODUCTS } from "../lib/products.js";
 import { TOOLS, createSession } from "../lib/mcp/diya-gl-tools.js";
 import { writeBookDirectory } from "./export.js";
@@ -52,7 +53,7 @@ async function readBook(source) {
   if (statSync(path).isDirectory()) {
     return parseDiyaGlData(readFileSync(join(path, "book.toml"), "utf8"), readFileSync(join(path, "lines.jsonl"), "utf8"));
   }
-  const { book, lines } = await readBookSource(readFileSync(path), source, { products: PRODUCTS });
+  const { book, lines } = await readBookSource(readFileSync(path), source, { products: PRODUCTS, suiteConcepts: frcSuiteConcepts });
   return { book, lines };
 }
 

package/dist/app/bin/write-workbook.js

@@ -18,6 +18,7 @@ import { readFileSync, writeFileSync, mkdirSync } from "fs";
 import { resolve } from "path";
 import { loadDiyaGlData } from "../lib/diya-gl-loader.js";
 import { readBookSource } from "../lib/diya-gl-interchange.js";
+import { frcSuiteConcepts } from "../lib/frc-suite-concepts-node.js";
 import { saveWorkbook, saveWorkbookFiles, savePackageZip, productOf } from "../lib/product-workbook.js";
 import { productModule, PRODUCTS } from "../lib/products.js";
 
@@ -59,7 +60,7 @@ async function loadBookAndLines(dataDir, file, offset) {
     return loadDiyaGlData(resolve(dataDir), offset);
   }
   const bytes = readFileSync(resolve(file));
-  const { book, lines } = await readBookSource(bytes, file, { products: PRODUCTS });
+  const { book, lines } = await readBookSource(bytes, file, { products: PRODUCTS, suiteConcepts: frcSuiteConcepts });
   return { book, lines };
 }