@crewhaus/tool-ledger 0.7.0 → 0.8.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,9 @@
+CrewHaus Factory
+Copyright 2026 Max Meier
+
+This product includes software developed by Max Meier
+(operating as StudioMax — https://studiomax.io) and contributors.
+
+The CrewHaus name and logo are trademarks of Max Meier. See
+https://github.com/crewhaus/factory/blob/main/TRADEMARK.md for the
+use-of-marks policy.

package/README.md

@@ -123,7 +123,10 @@ unmatched.
 Rows on both sides use `@crewhaus/tool-money`'s `Transaction` — the shape
 `StatementParse` produces — imported rather than re-declared. A side with
 `kind: "statement"` is read through tool-money's own parser, so a file whose
-dates could be day-first or month-first is refused there too.
+dates could be day-first or month-first is refused there too. A statement row
+that parser could not read is in neither the matched nor the unmatched lists,
+so it is named in `unreadableStatementRows` (a count per side and the first
+fifty, with reasons) rather than silently missing.
 
 ## Aging refuses rather than answering partially
 

package/dist/index.js

@@ -29,10 +29,9 @@
  * `_setClock`, so a test can fix `postedAt` — which is inside the hash chain,
  * so a wall-clock read would make the same posting hash differently twice.
  */
-import { mkdirSync, readFileSync, renameSync, statSync, writeFileSync } from "node:fs";
-import { dirname, join } from "node:path";
 import { buildTool } from "@crewhaus/tool-builder";
 import { parseStatement } from "@crewhaus/tool-money";
+import { joinRel, openForReadSync, writeFileSafe } from "@crewhaus/tool-safety/fs";
 import { z } from "zod";
 import { LedgerError, assertInstant, assertIsoDate, canonicalJson, exponentFor, json, parseMinorUnits, sha256Hex, } from "./lib/amount";
 import { ACCOUNT_TYPES, DEFAULT_BUSY_TIMEOUT_MS, inImmediateTransaction, openDb, readMeta, writeMeta, } from "./lib/db";
@@ -40,7 +39,7 @@ import { BUILTIN_TEMPLATES, DOCUMENT_KINDS, OUTPUT_FORMATS, allocateDocument, as
 import { POST_LIMITS, ensureAccounts, postBatch } from "./lib/post";
 import { FORMATS, VIEWS, renderRows, runQuery } from "./lib/query";
 import { RECONCILE_LIMITS, reconcile } from "./lib/reconcile";
-import { resolveSafe } from "./paths";
+import { resolveSafe, workspaceRoot } from "./paths";
 // ---------------------------------------------------------------------------
 // the one seam
 // ---------------------------------------------------------------------------
@@ -183,6 +182,7 @@ const entrySchema = z
     .strict();
 export const ledgerPost = buildTool({
     name: "LedgerPost",
+    operativeArgs: [{ field: "dbPath", kind: "path", default: DEFAULT_DB_PATH }],
     description: "Append balanced double-entry journal entries to a local, hash-chained SQLite ledger, refusing anything that would corrupt it. Use it instead of having a model track what has been booked: debits must equal credits or the entry is rejected with the difference named, a (source system, id) pair can only post once, a closed period stays closed, and the rows, the chain's new head and the idempotency claim all commit in ONE transaction — so a crash mid-batch leaves the book exactly as it was rather than a ledger that verifies while its duplicate suppression has forgotten the entry. Amounts are decimal strings or integer minor units, never floats. Nothing is transmitted anywhere; this writes a file.",
     inputSchema: z
         .object({
@@ -369,6 +369,8 @@ export const ledgerQuery = buildTool({
 // LedgerReconcile
 // ---------------------------------------------------------------------------
 const MAX_STATEMENT_BYTES = 64 * 1024 * 1024;
+/** A template file, like an inline `template`, is at most 256 KiB. */
+const MAX_TEMPLATE_BYTES = 256 * 1024;
 /** The row shape is `@crewhaus/tool-money`'s, so the schema mirrors it exactly. */
 const transactionSchema = z
     .object({
@@ -403,45 +405,72 @@ const sideSchema = z
     to: isoDate.optional(),
 })
     .strict();
+/** How many of a statement's unreadable rows a reconciliation lists by name. */
+const UNREADABLE_ROWS_SHOWN = 50;
 function loadSide(side, label, input) {
     if (side.kind === "lines") {
         if (side.lines === undefined)
             throw new LedgerError(`${label}.kind is "lines" but no lines were given`);
-        return side.lines;
+        return { rows: side.lines };
     }
     if (side.kind === "statement") {
         if (side.file === undefined)
             throw new LedgerError(`${label}.kind is "statement" but no file was given`);
-        const at = resolveSafe("LedgerReconcile", side.file);
-        const size = statSync(at.real).size;
-        if (size > MAX_STATEMENT_BYTES) {
-            throw new LedgerError(`${at.rel} is ${size} bytes, over the ${MAX_STATEMENT_BYTES}-byte limit`);
-        }
         // tool-money's parser, not a second one: it is the thing that refuses a
         // file whose dates could be day-first or month-first, and a reconciliation
-        // run on months guessed the wrong way balances to twice the error.
-        return [
-            ...parseStatement(readTextFile(at.real), {
-                dateOrder: side.dateOrder,
-                decimalComma: side.decimalComma,
-                decimals: side.decimals,
-            }).transactions,
-        ];
+        // run on months guessed the wrong way balances to twice the error. It
+        // holds one row past the side limit, so an over-long file is refused by
+        // its true count without every row of it in memory first.
+        const parsed = parseStatement(readTextFile("LedgerReconcile", side.file, MAX_STATEMENT_BYTES), {
+            dateOrder: side.dateOrder,
+            decimalComma: side.decimalComma,
+            decimals: side.decimals,
+            keep: { transactions: RECONCILE_LIMITS.rowsPerSide + 1, rejected: UNREADABLE_ROWS_SHOWN },
+        });
+        if (parsed.count > RECONCILE_LIMITS.rowsPerSide) {
+            throw new LedgerError(`the ${label} side has ${parsed.count} rows, over the ${RECONCILE_LIMITS.rowsPerSide} limit`);
+        }
+        // A row the parser could not read is not in the reconciliation, so it is
+        // named beside it rather than silently missing from both sides.
+        return {
+            rows: parsed.transactions,
+            ...(parsed.rejectedCount === 0
+                ? {}
+                : { unreadable: { count: parsed.rejectedCount, rows: parsed.rejected } }),
+        };
     }
     if (side.account === undefined) {
         throw new LedgerError(`${label}.kind is "ledger" but no account was given`);
     }
     const opened = open("LedgerReconcile", input, "read");
     try {
-        return ledgerAsTransactions(opened.db, side.account, side.from, side.to);
+        return { rows: ledgerAsTransactions(opened.db, side.account, side.from, side.to) };
     }
     finally {
         opened.db.close();
     }
 }
-/** One place that reads a file, so one place decides how much of it is held. */
-function readTextFile(path) {
-    return readFileSync(path, "utf-8");
+/**
+ * One place that reads a caller-named file, so one place decides where it
+ * may be, what kind of file it may be and how much of it is held.
+ *
+ * The path is contained first, with the refusal every path here gives. The
+ * file is then opened without blocking and must be a regular file: a FIFO
+ * with no writer blocks an ordinary open for ever, and this read is
+ * synchronous, so a named pipe planted in the workspace used to stop the
+ * whole harness, heartbeats and other sessions included. And the byte limit
+ * is enforced while reading, not by a size the file reported before it was
+ * opened.
+ */
+function readTextFile(toolName, given, maxBytes) {
+    resolveSafe(toolName, given);
+    const read = openForReadSync(workspaceRoot(), given, { maxBytes });
+    if (!read.ok)
+        throw new LedgerError(`${toolName}: ${read.reason}`);
+    if (read.truncated) {
+        throw new LedgerError(`${toolName}: ${JSON.stringify(given)} is over the ${maxBytes}-byte limit, so it was not read`);
+    }
+    return read.text;
 }
 /**
  * One account's posted lines as statement rows.
@@ -547,7 +576,9 @@ export const ledgerReconcile = buildTool({
     concurrencySafe: true,
     execute: async (input) => {
         const currency = (input.currency ?? "USD").toUpperCase();
-        const result = reconcile(loadSide(input.left, "left", input), loadSide(input.right, "right", input), {
+        const left = loadSide(input.left, "left", input);
+        const right = loadSide(input.right, "right", input);
+        const result = reconcile(left.rows, right.rows, {
             toleranceMinor: BigInt(input.toleranceMinor ?? 0),
             windowDays: input.windowDays ?? 3,
             allowManyToOne: input.allowManyToOne !== false,
@@ -559,7 +590,19 @@ export const ledgerReconcile = buildTool({
             currency,
             propose: input.propose,
         });
-        return json(result);
+        const unreadable = {
+            ...(left.unreadable === undefined ? {} : { left: left.unreadable }),
+            ...(right.unreadable === undefined ? {} : { right: right.unreadable }),
+        };
+        return json(Object.keys(unreadable).length === 0
+            ? result
+            : {
+                ...result,
+                // Statement rows that could not be read, and so are in neither
+                // the matched nor the unmatched lists: the reconciliation does
+                // not cover them.
+                unreadableStatementRows: unreadable,
+            });
     },
 });
 // ---------------------------------------------------------------------------
@@ -576,6 +619,13 @@ const partySchema = z
     .strict();
 export const invoiceRender = buildTool({
     name: "InvoiceRender",
+    // `templateFile` is read into the rendered document: a deny or ask reads
+    // it, an allow on where the tool writes need not.
+    operativeArgs: [
+        { field: "dbPath", kind: "path", default: DEFAULT_DB_PATH },
+        { field: "outDir", kind: "path", beneath: "all" },
+        { field: "templateFile", kind: "path", source: true },
+    ],
     description: "Render an invoice, receipt, credit note or quote to HTML, Markdown and JSON with a gap-free document number and totals computed rather than supplied. Use it instead of a model emitting invoice HTML: the number and the document record are allocated in ONE transaction, so a crash cannot burn a number out of a legally required sequence, and repeating the call with the same idempotency key returns the same number and the same bytes. Nothing is formatted through Intl, so the output does not move with an ICU upgrade; the yearly reset takes its year from the issue date, not the clock. Files are written under the workspace. It submits nothing and asks for no payment credentials.",
     inputSchema: z
         .object({
@@ -707,7 +757,7 @@ export const invoiceRender = buildTool({
         }
         const custom = input.templateFile === undefined
             ? input.template
-            : readTextFile(resolveSafe("InvoiceRender", input.templateFile).real);
+            : readTextFile("InvoiceRender", input.templateFile, MAX_TEMPLATE_BYTES);
         // The hash covers everything that determines the rendered bytes, so a
         // replay under the same key can be checked for being the same document —
         // and a re-render after a crash produces byte-identical files.
@@ -796,21 +846,36 @@ export const invoiceRender = buildTool({
         const files = [];
         if (outDir !== null) {
             const dir = outDir;
-            mkdirSync(dir.real, { recursive: true });
             for (const [format, text] of Object.entries(rendered).sort()) {
                 const name = `${allocation.number}.${format === "markdown" ? "md" : format}`;
-                // Belt and braces over the check above: the composed path goes back
-                // through the workspace resolver, so containment is enforced by the
-                // resolver every other path in this package uses and not only by the
-                // character rule that produced this name.
-                const target = resolveSafe("InvoiceRender", `${dir.rel}/${name}`).abs;
-                // Written to a temporary name and renamed: a rename within one
-                // directory is atomic, so a reader never sees half an invoice, and a
-                // crash mid-write leaves the previous file rather than a truncated one.
-                const temp = `${target}.${payloadHash.slice(0, 8)}.tmp`;
-                mkdirSync(dirname(temp), { recursive: true });
-                writeFileSync(temp, text, "utf-8");
-                renameSync(temp, target);
+                const rel = joinRel(dir.rel, name);
+                // Belt and braces over the check above: the composed path is contained
+                // again where it is written, by the physical location of its directory
+                // and its leaf, not only by the character rule that produced the name.
+                // writeFileSafe writes a temp under a RANDOM name, created
+                // O_EXCL|O_NOFOLLOW beside the target, and renames it into place: a
+                // reader never sees half an invoice, a crash leaves the previous file,
+                // and nothing is written through a link that LEAVES the workspace. The
+                // old temp name (`<target>.<hash8>.tmp`) was predictable from the
+                // caller's own input, so a link planted there wrote the invoice
+                // outside the workspace and left the target linked out. Missing
+                // directories under outDir are created one at a time, each checked. A
+                // link at the target that stays inside the workspace is followed (an
+                // operator who archives invoices behind a link keeps working, as on
+                // 0.7.0); a link OUT of the workspace, or a FIFO or other special
+                // file, is refused.
+                const written = writeFileSafe(workspaceRoot(), rel, text, {
+                    overwrite: true,
+                    createParents: true,
+                    leafSymlink: "follow-contained",
+                });
+                if (!written.ok) {
+                    // The number is already allocated and recorded with this payload, so
+                    // it is not lost: a replay under the same key re-renders these bytes.
+                    // written.reason already states nothing was written, so it is not
+                    // repeated here.
+                    throw new LedgerError(`InvoiceRender: ${allocation.number} is allocated and recorded, but its file could not be written — ${written.reason}. Fix the destination (a link out of the workspace, or a special file at the target: move it aside, or choose another outDir) and repeat the call with the same idempotencyKey to write the same files.`);
+                }
                 files.push(`${dir.rel}/${name}`);
             }
         }

package/dist/lib/invoice.js

@@ -6,6 +6,22 @@ export const INVOICE_LIMITS = {
     lines: 1_000,
     templateBytes: 256 * 1024,
 };
+/**
+ * `digits` in groups of three from the right, joined by `group`.
+ *
+ * Sliced and joined, never `replace(regex, group)`: the separator is the
+ * caller's text, and as a replacement STRING its `$'`, `` $` `` and `$1`
+ * expanded to pieces of the number, so a separator of `$'` rendered
+ * 1234567.89 as "1234567234567567.89" — a wrong amount on an invoice. The
+ * lookahead regex was also quadratic in the digit count.
+ */
+function groupDigits(digits, group) {
+    const head = digits.length % 3 || 3;
+    const parts = [digits.slice(0, head)];
+    for (let at = head; at < digits.length; at += 3)
+        parts.push(digits.slice(at, at + 3));
+    return parts.join(group);
+}
 /**
  * Minor units as the document shows them. No `Intl`, on purpose (see above):
  * the digits come from exact bigint arithmetic and the separators come from
@@ -20,7 +36,7 @@ export function formatAmount(minor, exponent, options = {}) {
     const fraction = dot === -1 ? "" : body.slice(dot + 1);
     const group = options.groupSeparator ?? "";
     if (group !== "")
-        whole = whole.replace(/\B(?=(\d{3})+(?!\d))/g, group);
+        whole = groupDigits(whole, group);
     const decimal = options.decimalSeparator ?? ".";
     return `${negative ? "-" : ""}${whole}${fraction === "" ? "" : decimal + fraction}`;
 }

package/dist/paths.d.ts

@@ -1,10 +1,29 @@
 import { CrewhausError } from "@crewhaus/errors";
-/** Raised when a caller-supplied path resolves outside the workspace root. */
+/**
+ * The longest path this resolves, in UTF-16 code units; a longer one is
+ * refused before it is walked. Nothing that long can be opened or created:
+ * PATH_MAX is 1,024 bytes on macOS and 4,096 on Linux, Windows stops at
+ * 32,767 UTF-16 units, and a path's UTF-8 form is never shorter than its
+ * UTF-16 one. The limit is twice that because the part of a path that exists
+ * is itself under PATH_MAX, so the part that does not is over PATH_MAX on its
+ * own: no spelling of the place reaches it, not even one through a symlink
+ * that shortens the part that exists.
+ */
+export declare const MAX_PATH_CHARS: number;
+/**
+ * Raised when a caller-supplied path resolves outside the workspace root, or
+ * is longer than any path can be.
+ */
 export declare class ToolPermissionError extends CrewhausError {
     readonly name = "ToolPermissionError";
     readonly toolName: string;
     readonly path: string;
-    constructor(toolName: string, attemptedPath: string);
+    /**
+     * Why, when it is not that the location escapes the workspace root: a path
+     * longer than any path can be. A caller that rewords the refusal says this.
+     */
+    readonly reason: string | undefined;
+    constructor(toolName: string, attemptedPath: string, reason?: string);
 }
 /**
  * A validated path, in both forms the tools need.

package/dist/paths.js

@@ -11,15 +11,45 @@
 import { lstatSync, readlinkSync, realpathSync } from "node:fs";
 import * as path from "node:path";
 import { CrewhausError } from "@crewhaus/errors";
-/** Raised when a caller-supplied path resolves outside the workspace root. */
+/**
+ * The longest path this resolves, in UTF-16 code units; a longer one is
+ * refused before it is walked. Nothing that long can be opened or created:
+ * PATH_MAX is 1,024 bytes on macOS and 4,096 on Linux, Windows stops at
+ * 32,767 UTF-16 units, and a path's UTF-8 form is never shorter than its
+ * UTF-16 one. The limit is twice that because the part of a path that exists
+ * is itself under PATH_MAX, so the part that does not is over PATH_MAX on its
+ * own: no spelling of the place reaches it, not even one through a symlink
+ * that shortens the part that exists.
+ */
+export const MAX_PATH_CHARS = 2 * (process.platform === "darwin" ? 1_024 : process.platform === "win32" ? 32_767 : 4_096);
+/** A path as a refusal quotes it: whole, unless it is past {@link MAX_PATH_CHARS}. */
+function shownPath(given) {
+    return given.length > MAX_PATH_CHARS ? `${given.slice(0, 64)}…` : given;
+}
+/** Why a path past {@link MAX_PATH_CHARS} is refused: its length and the limit. */
+function tooLong(abs) {
+    return `it is ${abs.length} characters once resolved, over the ${MAX_PATH_CHARS}-character limit: no path that long can be opened or created`;
+}
+/**
+ * Raised when a caller-supplied path resolves outside the workspace root, or
+ * is longer than any path can be.
+ */
 export class ToolPermissionError extends CrewhausError {
     name = "ToolPermissionError";
     toolName;
     path;
-    constructor(toolName, attemptedPath) {
-        super("tool", `tool "${toolName}" rejected path "${attemptedPath}": resolved location escapes the workspace root`);
+    /**
+     * Why, when it is not that the location escapes the workspace root: a path
+     * longer than any path can be. A caller that rewords the refusal says this.
+     */
+    reason;
+    constructor(toolName, attemptedPath, reason) {
+        super("tool", reason === undefined
+            ? `tool "${toolName}" rejected path "${attemptedPath}": resolved location escapes the workspace root`
+            : `tool "${toolName}" rejected path "${shownPath(attemptedPath)}": ${reason}`);
         this.toolName = toolName;
         this.path = attemptedPath;
+        this.reason = reason;
     }
 }
 /** The workspace root, resolved. Every path is contained within it. */
@@ -67,15 +97,7 @@ function nameExists(p) {
 function resolveLocation(target, depth = 0) {
     if (depth > 40)
         throw new Error(`symlink chain at "${target}" is too long to resolve`);
-    let probe = target;
-    const tail = [];
-    while (!nameExists(probe)) {
-        tail.unshift(path.basename(probe));
-        const parent = path.dirname(probe);
-        if (parent === probe)
-            break; // reached the filesystem root
-        probe = parent;
-    }
+    const { probe, tail } = deepestName(target);
     let probeReal;
     try {
         probeReal = realpathSync(probe);
@@ -97,7 +119,41 @@ function resolveLocation(target, depth = 0) {
         const base = realpathSync(path.dirname(probe));
         probeReal = resolveLocation(path.resolve(base, link), depth + 1);
     }
-    return tail.length > 0 ? path.join(probeReal, ...tail) : probeReal;
+    // One string, not one argument per name: Bun's `path.join` keeps only
+    // (argument count mod 65,536) of its arguments.
+    return tail.length > 0 ? path.join(probeReal, tail) : probeReal;
+}
+/**
+ * `target`, an absolute path, split where its deepest prefix that exists as
+ * a NAME ends: that prefix, and the names below it, which do not exist, as
+ * one string ("" when `target` itself exists). This is `path.dirname` and
+ * `path.basename` worked by index on `target` itself: handing them each
+ * shorter prefix in turn copied the rest of the path once per missing name,
+ * the square of a count the caller picks.
+ */
+function deepestName(target) {
+    const top = path.parse(target).root.length;
+    const isSep = (i) => target[i] === "/" || target[i] === path.sep;
+    let probe = target;
+    let start = target.length;
+    let stop = -1;
+    while (!nameExists(probe)) {
+        // `path.basename(probe)` is `target.slice(start, end)`, and
+        // `path.dirname(probe)` is `target.slice(0, up)`.
+        let end = probe.length;
+        while (end > top && isSep(end - 1))
+            end--;
+        if (stop < 0)
+            stop = end;
+        start = end;
+        while (start > top && !isSep(start - 1))
+            start--;
+        const up = start > top ? start - 1 : top;
+        if (up === probe.length)
+            break; // reached the filesystem root
+        probe = target.slice(0, up);
+    }
+    return { probe, tail: stop < 0 ? "" : target.slice(start, stop) };
 }
 export function resolveSafe(toolName, rel, root = workspaceRoot()) {
     const rootResolved = path.resolve(root);
@@ -107,6 +163,9 @@ export function resolveSafe(toolName, rel, root = workspaceRoot()) {
     if (abs !== rootResolved && !abs.startsWith(`${rootResolved}${path.sep}`)) {
         throw new ToolPermissionError(toolName, rel);
     }
+    // Longer than any path can be: refused before the walk below reads it.
+    if (abs.length > MAX_PATH_CHARS)
+        throw new ToolPermissionError(toolName, rel, tooLong(abs));
     let real;
     try {
         const rootReal = realpathSync(rootResolved);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crewhaus/tool-ledger",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "type": "module",
   "description": "Deterministic double-entry ledger: hash-chained postings, queries, reconciliation and invoice rendering",
   "main": "dist/index.js",
@@ -8,19 +8,21 @@
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
-      "import": "./dist/index.js"
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
     }
   },
   "scripts": {
     "test": "bun test src"
   },
   "dependencies": {
-    "@crewhaus/errors": "0.7.0",
-    "@crewhaus/tool-builder": "0.7.0",
-    "@crewhaus/tool-catalog": "0.7.0",
-    "@crewhaus/tool-datetime": "0.7.0",
-    "@crewhaus/tool-math": "0.7.0",
-    "@crewhaus/tool-money": "0.7.0",
+    "@crewhaus/errors": "0.8.0",
+    "@crewhaus/tool-builder": "0.8.0",
+    "@crewhaus/tool-catalog": "0.8.0",
+    "@crewhaus/tool-datetime": "0.8.0",
+    "@crewhaus/tool-math": "0.8.0",
+    "@crewhaus/tool-money": "0.8.0",
+    "@crewhaus/tool-safety": "0.8.0",
     "zod": "^3.23.8"
   },
   "devDependencies": {
@@ -44,5 +46,8 @@
   "publishConfig": {
     "access": "public"
   },
-  "files": ["dist", "README.md", "LICENSE", "NOTICE"]
+  "files": ["dist", "README.md", "LICENSE", "NOTICE"],
+  "engines": {
+    "bun": ">=1.3.14"
+  }
 }