@invompt/invoml 1.0.0-alpha.4

package/LICENSE

@@ -0,0 +1,190 @@
+                                 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 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, as submitted to the 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 designated in writing by the copyright owner as "Not a
+      Contribution."
+
+      "Contributor" shall mean Licensor and any Legal Entity on behalf of
+      whom a Contribution has been received by the Licensor and included
+      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 the 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 any such
+      Contribution 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 Work 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, You must include a readable copy of the attribution
+          notices contained within such NOTICE file, 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 license statement for Your modifications and
+      may provide additional grant of rights to use, copy, modify, merge,
+      publish, distribute, sublicense, and/or sell copies of the Work,
+      and to permit persons to whom the Work is provided to do so, subject
+      to the following terms and conditions.
+
+   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 conditions of TITLE,
+      NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR
+      PURPOSE. You are solely responsible for determining the
+      appropriateness of using or reproducing 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 exemplary damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (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 offer such
+      conditions 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 format in question. Please also include a
+      "NOTICE" or "LICENSE" file in the project root to inform users
+      of the License terms.
+
+   Copyright 2026 Invompt
+
+   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/README.md

@@ -0,0 +1,320 @@
+# InvoML — Invoice Markup Language
+
+**A specification for AI-generated invoice documents. Deterministic math, human-readable format, international tax coverage.**
+
+[![npm version](https://img.shields.io/npm/v/@invompt/invoml?style=flat-square)](https://www.npmjs.com/package/@invompt/invoml)
+[![license](https://img.shields.io/badge/license-Apache--2.0-blue?style=flat-square)](./LICENSE)
+[![CI](https://img.shields.io/github/actions/workflow/status/invompt/InvoML/ci.yml?style=flat-square)](https://github.com/invompt/InvoML/actions)
+[![TypeScript](https://img.shields.io/badge/TypeScript-strict-3178c6?style=flat-square)](https://www.typescriptlang.org/)
+[![test vectors](https://img.shields.io/badge/test_vectors-18-brightgreen?style=flat-square)](./test-vectors/)
+
+InvoML is a **format specification** for invoice documents designed from the ground up for AI structured output and human authoring. `@invompt/invoml` is the official TypeScript reference implementation.
+
+---
+
+## The Problem
+
+Every time an AI model generates an invoice today, it faces the same dilemma: which format?
+
+**Traditional business document formats were designed for enterprise systems, not AI.** They use verbose XML with deeply nested structures — a simple invoice can require hundreds of tokens of boilerplate before the first data field appears. They handle data exchange between machines but leave human presentation entirely to the renderer — with no way for the document to carry visual intent.
+
+**The same invoice in InvoML:**
+
+```json
+{
+  "$invoml": "1.0",
+  "meta": { "documentType": "invoice", "number": "INV-2026-0001",
+            "issueDate": "2026-03-28", "currency": "USD",
+            "tax": { "label": "Tax", "rate": 10 } },
+  "from": { "name": "Acme Corp", "content": "**Acme Corp**\n123 Main St" },
+  "to":   { "name": "Client LLC" },
+  "items": [
+    { "description": "Consulting", "quantity": 10, "unitPrice": 200.00 }
+  ]
+}
+```
+
+**Ad-hoc JSON doesn't solve it either:** totals are pre-calculated by the model (floating-point errors, hallucinated numbers), there is no validation contract, and renderers must guess at structure.
+
+InvoML solves all three problems. It is compact enough for token-sensitive LLM calls, carries a JSON Schema for structured output APIs, and defines deterministic calculation rules that guarantee byte-identical totals across every runtime and language.
+
+---
+
+## How It Works
+
+```
+┌─────────────────────┐      ┌──────────────────────┐      ┌─────────────────────┐
+│                     │      │                       │      │                     │
+│   AI generates      │ ───▶ │  Runtime calculates   │ ───▶ │  Renderer displays  │
+│   InvoML document   │      │  all arithmetic       │      │  the final invoice  │
+│                     │      │                       │      │                     │
+│  data only, no      │      │  arbitrary-precision  │      │  PDF, HTML, email,  │
+│  pre-computed sums  │      │  decimal math         │      │  Markdown, any UI   │
+│                     │      │                       │      │                     │
+└─────────────────────┘      └──────────────────────┘      └─────────────────────┘
+```
+
+The spec separates three responsibilities that every other format conflates:
+
+1. **Data** — what the invoice says (items, parties, tax rates, discounts)
+2. **Math** — deterministic rules the runtime always executes (subtotals, rounding, tax cascades)
+3. **Presentation** — how it looks. The optional `style` field carries visual intent: block ordering, named templates, CSS-compatible properties. Compact enough for AI to include (18–60 tokens), expressive enough for real invoices.
+
+AI models only produce layer 1. The runtime owns layer 2. Renderers own layer 3.
+
+---
+
+## Quick Example
+
+A minimal invoice with a single line and 10% VAT:
+
+```json
+{
+  "$invoml": "1.0",
+  "meta": {
+    "documentType": "invoice",
+    "number": "INV-001",
+    "issueDate": "2026-03-28",
+    "currency": "EUR",
+    "tax": { "label": "VAT", "rate": 10 }
+  },
+  "from": { "name": "Studio Craft", "content": "**Studio Craft**\nBerlin, Germany" },
+  "to":   { "name": "Client GmbH",  "content": "**Client GmbH**\nMunich, Germany" },
+  "items": [
+    { "description": "Logo Design", "quantity": 1, "unitPrice": 1200.00 }
+  ]
+}
+```
+
+The runtime calculates:
+
+| Field        | Value     |
+|--------------|-----------|
+| Subtotal     | €1,200.00 |
+| VAT (10%)    | €120.00   |
+| **Total**    | **€1,320.00** |
+
+Numbers are computed from spec rules, never guessed by the model.
+
+### With visual intent
+
+The same invoice, with the AI expressing how it should look:
+
+```json
+{
+  "$invoml": "1.0",
+  "meta": {
+    "documentType": "invoice",
+    "number": "INV-001",
+    "issueDate": "2026-03-28",
+    "currency": "EUR",
+    "tax": { "label": "VAT", "rate": 10 }
+  },
+  "from": { "content": "**Studio Craft**\nBerlin, Germany" },
+  "to":   { "content": "**Client GmbH**\nMunich, Germany" },
+  "items": [
+    { "description": "Logo Design", "quantity": 1, "unitPrice": 1200.00 }
+  ],
+  "style": {
+    "template": "modern",
+    "properties": { "--accent": "#e63946", "font-family": "Georgia, serif" },
+    "blocks": {
+      "header": { "text-align": "center", "border-bottom": "2px solid #e63946" }
+    }
+  }
+}
+```
+
+The `style` object adds ~30 tokens. The renderer uses it to produce a visually distinct document — centered header, serif font, red accent — while the math and data remain unchanged. Without `style`, the renderer applies its own defaults. This is optional: most invoices don't need it.
+
+---
+
+## Reference Implementation
+
+`@invompt/invoml` is the official TypeScript implementation of the InvoML v1.0 specification.
+
+```bash
+npm install @invompt/invoml
+```
+
+### Parse and validate
+
+```typescript
+import { parse, calculate, toMarkdown } from '@invompt/invoml'
+
+const result = parse(jsonString)
+if (!result.success) {
+  console.error(result.errors)
+  process.exit(1)
+}
+```
+
+### Calculate totals
+
+```typescript
+const totals = calculate(result.document)
+
+console.log(totals.subtotal)   // 1200
+console.log(totals.taxTotal)   // 120
+console.log(totals.total)      // 1320
+console.log(totals.amountDue)  // 1320
+```
+
+All arithmetic uses arbitrary-precision decimal math (`decimal.js`). No floating-point rounding errors. Results are byte-identical across Node.js versions and operating systems.
+
+### Render to Markdown
+
+```typescript
+// Attach totals to the document, then render
+const doc = { ...result.document, totals }
+const md = toMarkdown(doc)
+// Ready for chat interfaces, email previews, plain-text pipelines
+```
+
+### API surface
+
+| Function | Description |
+|---|---|
+| `parse(json)` | Parse and type-validate a JSON string into `InvoMLDocument` |
+| `calculate(doc)` | Compute all totals with arbitrary-precision math |
+| `validateSchema(value)` | Validate against the JSON Schema (useful before `parse`) |
+| `toJSON(doc, options?)` | Serialize to JSON. Pass `{ compact: true }` for minified output |
+| `toMarkdown(doc)` | Render as a human-readable Markdown table (reads `doc.totals`) |
+| `toHTML(doc)` | Render as a self-contained HTML document |
+| `validateStyle(style, sectionNames?)` | Validate a style object against normative rules |
+| `resolveOrder(doc)` | Resolve effective block rendering order for a document |
+| `resolveStyle(doc)` | Resolve the full style object with defaults applied |
+
+---
+
+## Ecosystem
+
+### JSON Schema for LLM structured output
+
+The InvoML v1.0 JSON Schema is at [`invoml-v1.0.schema.json`](./invoml-v1.0.schema.json). Pass it directly to any LLM structured-output API:
+
+```typescript
+import schema from '@invompt/invoml/invoml-v1.0.schema.json' assert { type: 'json' }
+
+// OpenAI structured outputs
+const completion = await openai.beta.chat.completions.parse({
+  model: 'gpt-4o',
+  response_format: { type: 'json_schema', json_schema: { schema } },
+  messages: [{ role: 'user', content: 'Generate an invoice for ...' }]
+})
+
+// Anthropic tool use
+const message = await anthropic.messages.create({
+  tools: [{ name: 'generate_invoice', input_schema: schema }],
+  // ...
+})
+```
+
+### CLI
+
+```bash
+# Validate a document against the spec
+npx @invompt/invoml validate invoice.json
+
+# Calculate and print totals
+npx @invompt/invoml calculate invoice.json
+
+# Serialize to canonical JSON with computed totals
+npx @invompt/invoml serialize invoice.json
+
+# Render as a self-contained HTML file
+npx @invompt/invoml html invoice.json > invoice.html
+```
+
+### Test vectors for conformance
+
+The [`test-vectors/`](./test-vectors/) directory contains 18 canonical input/expected pairs. Any implementation claiming InvoML v1.0 conformance must pass all 18 vectors.
+
+| # | Scenario |
+|---|---|
+| 01 | Minimal invoice (no tax) |
+| 02 | Basic VAT |
+| 03 | Multi-rate EU VAT |
+| 04 | Invoice-level proportional discount |
+| 05 | Line-level discounts |
+| 06 | Cascading discounts |
+| 07 | Compound tax (Canada GST + PST) |
+| 08 | Inclusive tax (Australia GST) |
+| 09 | Reverse charge (zero-rate VAT) |
+| 10 | Withholding tax |
+| 11 | Rounding edge case |
+| 12 | Zero subtotal |
+| 13 | Credit note |
+| 14 | Inclusive tax with invoice-level discount |
+| 15 | Compound withholding |
+| 16 | Error — unknown tax category |
+| 17 | Error — no default tax |
+| 18 | Proportional discount tie-breaking |
+
+---
+
+## International Coverage
+
+InvoML covers 15+ countries out of the box. The [`examples/`](./examples/) directory contains real-world documents for:
+
+**Tax models supported:**
+- Flat-rate VAT/GST (UK, EU, UAE, Switzerland, New Zealand, Australia)
+- Multi-rate VAT (EU — standard 19%/7%, zero-rate, exempt within the same document)
+- Compound taxes (Canada — GST + PST calculated on different bases)
+- Inclusive taxes (Australia GST — tax embedded in the listed price)
+- Reverse charge (EU cross-border — tax shifts to buyer)
+- Withholding taxes (Nigeria, Mexico — issuer reports, buyer remits)
+- CFDI-compatible (Mexico IVA with SAT registration fields)
+- ZUGFeRD-compatible field coverage (Germany)
+- IGST/CGST/SGST model (India)
+- Consumption tax (Japan 10%)
+
+**Document types:** invoices, quotes, estimates, receipts, credit notes
+
+---
+
+## For AI Developers
+
+Building an invoice generation feature? See [`docs/LLM-INTEGRATION.md`](./docs/LLM-INTEGRATION.md) for:
+
+- How to pass the InvoML schema to structured output APIs (OpenAI, Anthropic, Google)
+- System prompt patterns that produce valid InvoML reliably
+- How to validate AI output before calling `calculate`
+- Handling edge cases: unknown tax categories, missing currency symbols, model hallucinations
+
+---
+
+## Specification
+
+The InvoML v1.0 specification (currently Draft) lives in [`SPEC.md`](./SPEC.md). It defines:
+
+- Document structure and required fields
+- Tax resolution rules (simple, full, compound, inclusive, withholding, reverse charge)
+- Discount application order (line-level before invoice-level, proportional allocation)
+- Rounding rules (half-up, currency-precision)
+- Style model: block ordering, named templates, freeform CSS-compatible properties
+- Conformance requirements for independent implementations
+
+The `@invompt/invoml` reference implementation is normative for any case where the spec text is ambiguous. If `@invompt/invoml` and `SPEC.md` disagree, file an issue — both will be corrected.
+
+---
+
+## Why InvoML?
+
+Existing invoice standards were built for enterprise systems — they handle data exchange between machines but say nothing about how the document should look. Ad-hoc JSON handles neither reliably. InvoML covers the full pipeline: AI generates structured data with optional visual intent, the runtime computes deterministic totals, and renderers produce polished output for humans.
+
+See [`docs/WHY-INVOML.md`](./docs/WHY-INVOML.md) for a detailed comparison with UBL, ad-hoc JSON, and platform-specific formats.
+
+---
+
+## Contributing
+
+See [CONTRIBUTING.md](./CONTRIBUTING.md) for development setup, test vector authoring, and the pull request process.
+
+Implementations in other languages are welcome. Any implementation that passes all 18 test vectors and implements the arithmetic rules in `SPEC.md` is a conforming InvoML v1.0 implementation.
+
+---
+
+## License
+
+Apache-2.0 — see [LICENSE](./LICENSE)

package/dist/cli/invoml.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/cli/invoml.js

@@ -0,0 +1,78 @@
+#!/usr/bin/env node
+import { readFileSync } from 'fs';
+import { parse } from '../src/parser.js';
+import { calculate } from '../src/calculator.js';
+import { validateSchema } from '../src/schema.js';
+import { toJSON, toMarkdown } from '../src/serializer.js';
+import { toHTML } from '../src/html-renderer.js';
+const [, , command, file, format] = process.argv;
+if (!command || !file) {
+    console.log('Usage: invoml <validate|calculate|serialize|html> <file.json> [format]');
+    process.exit(1);
+}
+let content;
+try {
+    content = readFileSync(file, 'utf8');
+}
+catch (e) {
+    console.error(`Error reading file "${file}": ${e.message}`);
+    process.exit(1);
+}
+if (command === 'validate') {
+    let doc;
+    try {
+        doc = JSON.parse(content);
+    }
+    catch (e) {
+        console.error(`Invalid JSON in "${file}": ${e.message}`);
+        process.exit(1);
+    }
+    const result = validateSchema(doc);
+    if (result.valid) {
+        console.log('Valid InvoML document.');
+    }
+    else {
+        console.error('Validation errors:');
+        result.errors.forEach(e => console.error(`  - ${e}`));
+        process.exit(1);
+    }
+}
+else if (command === 'calculate') {
+    const result = parse(content);
+    if (!result.success) {
+        console.error('Parse errors:');
+        result.errors.forEach(e => console.error(`  - ${e}`));
+        process.exit(1);
+    }
+    const totals = calculate(result.document);
+    console.log(JSON.stringify(totals, null, 2));
+}
+else if (command === 'serialize') {
+    const result = parse(content);
+    if (!result.success) {
+        console.error('Parse errors:');
+        result.errors.forEach(e => console.error(`  - ${e}`));
+        process.exit(1);
+    }
+    const doc = { ...result.document, totals: calculate(result.document) };
+    if (format === 'md' || format === 'markdown') {
+        console.log(toMarkdown(doc));
+    }
+    else {
+        console.log(toJSON(doc));
+    }
+}
+else if (command === 'html') {
+    const result = parse(content);
+    if (!result.success) {
+        console.error('Parse errors:');
+        result.errors.forEach(e => console.error(`  - ${e}`));
+        process.exit(1);
+    }
+    const doc = { ...result.document, totals: calculate(result.document) };
+    console.log(toHTML(doc));
+}
+else {
+    console.error(`Unknown command: ${command}`);
+    process.exit(1);
+}

package/dist/src/calculator.d.ts

@@ -0,0 +1,3 @@
+import type { InvoMLDocument, InvoMLTotals } from './types.js';
+/** Compute all totals for an InvoML document using arbitrary-precision decimal arithmetic. Returns subtotal, per-category tax breakdowns, discount details, and amount due. */
+export declare function calculate(doc: InvoMLDocument): InvoMLTotals;