@hyperscale0/udl 1.0.0-rc.1 → 1.0.123

package/LICENSING.md

@@ -1,51 +0,0 @@
-# Licensing
-
-The code in this repository is Copyright 2026 Hyperscale LLC and is licensed
-under the GNU Affero General Public License version 3 only
-(`AGPL-3.0-only`). The full text is in [`LICENSE`](./LICENSE).
-
-## What the AGPL asks of you
-
-Two obligations matter in practice.
-
-**If you distribute a copy in object form**, modified or not, you make its
-Corresponding Source available under the same license.
-
-**If you run a modified copy as a network service**, section 13 applies: the
-users interacting with it over the network get an offer of the source of the
-version you are running. Running UDL unmodified behind your own service does
-not trigger this. Changing the parser, the validator, or the canonical
-serializer and then serving that change does.
-
-Using `@hyperscale0/udl` as a library inside your own program is a combined
-work under the AGPL. If that does not fit how you ship, take the commercial
-license instead.
-
-## Commercial license
-
-Hyperscale LLC sells a commercial license to organisations that cannot accept
-the AGPL, for the usual reasons: a proprietary product that links the library,
-a hosted service you will not open, a procurement policy that refuses copyleft.
-It grants the same code under ordinary commercial terms with no source
-obligation.
-
-Ask through <https://hyperscale0.ai>.
-
-## The license covers code, not marks
-
-"Hyperscale" and "UDL" are trademarks of Hyperscale LLC. A copyright license
-says nothing about trademarks in either direction, so
-[`TRADEMARKS.md`](./TRADEMARKS.md) draws that boundary.
-
-## The format is not the implementation
-
-UDL the format is separate from this implementation of it. The JSON Schema in
-[`spec/`](./spec) and the conformance cases in [`conformance/`](./conformance)
-are data describing a format, and anyone may write their own parser, validator,
-or serializer against them, in any language, under any license, without
-touching this code.
-
-What you may then say about it is a trademark question, not a copyright one.
-[`TRADEMARKS.md`](./TRADEMARKS.md) has the rule: claim compatibility with a UDL
-version only when your implementation passes that version's published
-conformance cases unmodified.

package/TRADEMARKS.md

@@ -1,35 +0,0 @@
-# Trademarks
-
-"Hyperscale" and "UDL" are trademarks of Hyperscale LLC.
-
-The AGPL covers the code in this repository and nothing else. It grants no
-rights to the marks, and it never mentions them: a copyright license says
-nothing about trademarks either way. This file draws that boundary so nobody
-has to guess where it sits.
-
-What that means in practice:
-
-- **Yes.** Say your project uses UDL, reads UDL, or is compatible with UDL.
-  Say it in your README, your docs, your talk, and your package description.
-  Fork this repository and keep the notices intact.
-- **Yes.** Publish a UDL implementation in another language, and name it in a
-  way that describes what it does: `udl-rs`, `udl-parser`, `python-udl`.
-- **No.** Name your project, company, or product in a way that suggests
-  Hyperscale LLC published it or endorses it. `@hyperscale0/*` on npm and the
-  `hyperscale0` GitHub organisation are ours.
-- **No.** Use the marks or our logo in a way that implies affiliation,
-  sponsorship, or certification we have not given.
-
-## Claiming compatibility
-
-An independent implementation may say it "implements UDL version X" or "passes
-the UDL conformance suite version X" only while it passes the published
-conformance cases for that version, unmodified. The cases in
-[`conformance/`](./conformance) are the whole test: no skipped case, no edited
-expectation, no local fork of the fixtures.
-
-That claim is a statement about your implementation, so keep the marks out of
-its name and off its logo, and do not present it as endorsement or
-certification by Hyperscale LLC. We certify nothing; the suite does.
-
-If you are unsure, open an issue and ask. Nobody has ever regretted asking.

package/conformance/README.md

@@ -1,82 +0,0 @@
-# The UDL conformance suite
-
-Every file here is data. An implementation in any language can run the suite
-without importing the TypeScript reference implementation.
-
-## Layout
-
-```
-conformance/
-  valid/<case>.udl
-  valid/<case>.expected.json
-  invalid/<case>.udl
-  invalid/<case>.expected.json
-  evolution/<case>.live.udl
-  evolution/<case>.next.udl
-  evolution/<case>.expected.json
-```
-
-The runner fails if either half of a case is missing. An evolution case must
-have all three named files.
-
-## Expected files
-
-A valid case:
-
-```json
-{
-  "canonical": "minimal.udl",
-  "digest": "c21d198d69e9d4cadb33aaacf37581bb388e4a8964b7fc284606cfa9f65d35bb",
-  "summary": "The smallest admitted document.",
-  "verdict": "valid"
-}
-```
-
-`digest` is lowercase SHA-256 over the canonical UTF-8 bytes. A document that
-is already canonical names itself.
-
-An invalid case:
-
-```json
-{
-  "issues": [{ "code": "UDL3001", "path": "$.instruments[0].actions" }],
-  "summary": "Every instrument declares create.",
-  "verdict": "invalid"
-}
-```
-
-The runner requires a non-blank `summary`. It never compares messages.
-
-## Conformance levels
-
-An implementation claims the highest level it passes.
-
-1. Verdict. Admit every `valid/` document and refuse every `invalid/` document.
-2. Canonical bytes. Serialize every valid document byte for byte as its named
-   canonical file, including the trailing line feed, and match its digest.
-3. Diagnostics. Report every listed code and path for each invalid document.
-   The implementation may report extra issues.
-4. Evolution. Admit both documents, then compare the live and next definitions.
-   Report every listed UDL7xxx code and path. The implementation may report
-   extra issues.
-
-## Path grammar
-
-Issue paths use `$` for the document root, `.name` for an object member, and
-`[n]` for a zero-based array index. Evolution paths use the instrument index
-from the live document and continue to the changed member, such as
-`$.instruments[3].actions.reconcile`. A direct `diffInstrumentEvolution` call
-has no document index, so its paths start at `$.instruments`.
-
-## Runner exit rule
-
-The runner exits 0 only if every case at the claimed level passes. A missing
-file, malformed expected file, unexpected verdict, byte mismatch, digest
-mismatch, or missing issue pair makes it exit nonzero.
-
-## Adding a case
-
-Start from the smallest admitted document that carries the needed clause.
-Change one law where possible. Pin codes and paths, never messages. Valid cases
-must keep one example of every target in `udlClauseVocabulary`, including
-quote, commit, reconcile, checks, updates, dials, effects, and money clauses.

package/conformance/evolution/action-contract.expected.json

@@ -1,10 +0,0 @@
-{
-  "issues": [
-    {
-      "code": "UDL7001",
-      "path": "$.instruments[0].actions.close"
-    }
-  ],
-  "summary": "Evolution identifies the changed action beneath the previous instrument index.",
-  "verdict": "invalid"
-}

package/conformance/evolution/action-contract.live.udl

@@ -1,44 +0,0 @@
-{
-  "instruments": [
-    {
-      "actionOrder": ["close", "create"],
-      "actions": {
-        "close": {
-          "moves": [],
-          "steps": [],
-          "summary": "Close the note."
-        },
-        "create": {
-          "moves": [],
-          "steps": [],
-          "summary": "File the note."
-        }
-      },
-      "fields": {
-        "reference": {
-          "type": "string"
-        }
-      },
-      "id": "note",
-      "idPrefix": "note",
-      "lifecycle": {
-        "initial": "open",
-        "states": ["open", "closed"],
-        "transitions": {
-          "close": {
-            "from": ["open"],
-            "to": "closed"
-          }
-        }
-      },
-      "required": ["reference"],
-      "summary": "A note a tenant files and later closes.",
-      "title": "Note"
-    }
-  ],
-  "product": "minimal",
-  "subjects": [],
-  "title": "Minimal",
-  "udl": 1,
-  "version": 1
-}

package/conformance/evolution/action-contract.next.udl

@@ -1,45 +0,0 @@
-{
-  "instruments": [
-    {
-      "actionOrder": ["close", "create"],
-      "actions": {
-        "close": {
-          "eventName": "note.closed",
-          "moves": [],
-          "steps": [],
-          "summary": "Close the note."
-        },
-        "create": {
-          "moves": [],
-          "steps": [],
-          "summary": "File the note."
-        }
-      },
-      "fields": {
-        "reference": {
-          "type": "string"
-        }
-      },
-      "id": "note",
-      "idPrefix": "note",
-      "lifecycle": {
-        "initial": "open",
-        "states": ["open", "closed"],
-        "transitions": {
-          "close": {
-            "from": ["open"],
-            "to": "closed"
-          }
-        }
-      },
-      "required": ["reference"],
-      "summary": "A note a tenant files and later closes.",
-      "title": "Note"
-    }
-  ],
-  "product": "minimal",
-  "subjects": [],
-  "title": "Minimal",
-  "udl": 1,
-  "version": 2
-}

package/conformance/evolution/product-identity.expected.json

@@ -1,10 +0,0 @@
-{
-  "issues": [
-    {
-      "code": "UDL7001",
-      "path": "$.product"
-    }
-  ],
-  "summary": "Evolution refusal for product id changed from minimal to renamed.",
-  "verdict": "invalid"
-}

package/conformance/evolution/product-identity.live.udl

@@ -1,55 +0,0 @@
-{
-  "instruments": [
-    {
-      "actionOrder": [
-        "close",
-        "create"
-      ],
-      "actions": {
-        "close": {
-          "moves": [],
-          "steps": [],
-          "summary": "Close the note."
-        },
-        "create": {
-          "moves": [],
-          "steps": [],
-          "summary": "File the note."
-        }
-      },
-      "fields": {
-        "reference": {
-          "type": "string"
-        }
-      },
-      "id": "note",
-      "idPrefix": "note",
-      "lifecycle": {
-        "initial": "open",
-        "states": [
-          "open",
-          "closed"
-        ],
-        "transitions": {
-          "close": {
-            "from": [
-              "open"
-            ],
-            "to": "closed"
-          }
-        }
-      },
-      "required": [
-        "reference"
-      ],
-      "summary": "A note a tenant files and later closes.",
-      "title": "Note"
-    }
-  ],
-  "product": "minimal",
-  "subjects": [],
-  "title": "Minimal",
-  "udl": 1,
-  "version": 1
-}
-

package/conformance/evolution/product-identity.next.udl

@@ -1,55 +0,0 @@
-{
-  "instruments": [
-    {
-      "actionOrder": [
-        "close",
-        "create"
-      ],
-      "actions": {
-        "close": {
-          "moves": [],
-          "steps": [],
-          "summary": "Close the note."
-        },
-        "create": {
-          "moves": [],
-          "steps": [],
-          "summary": "File the note."
-        }
-      },
-      "fields": {
-        "reference": {
-          "type": "string"
-        }
-      },
-      "id": "note",
-      "idPrefix": "note",
-      "lifecycle": {
-        "initial": "open",
-        "states": [
-          "open",
-          "closed"
-        ],
-        "transitions": {
-          "close": {
-            "from": [
-              "open"
-            ],
-            "to": "closed"
-          }
-        }
-      },
-      "required": [
-        "reference"
-      ],
-      "summary": "A note a tenant files and later closes.",
-      "title": "Note"
-    }
-  ],
-  "product": "renamed",
-  "subjects": [],
-  "title": "Minimal",
-  "udl": 1,
-  "version": 1
-}
-

package/conformance/evolution/version-required.expected.json

@@ -1,10 +0,0 @@
-{
-  "issues": [
-    {
-      "code": "UDL7002",
-      "path": "$.version"
-    }
-  ],
-  "summary": "Evolution refusal for product definition changed without increasing version 1.",
-  "verdict": "invalid"
-}

package/conformance/evolution/version-required.live.udl

@@ -1,55 +0,0 @@
-{
-  "instruments": [
-    {
-      "actionOrder": [
-        "close",
-        "create"
-      ],
-      "actions": {
-        "close": {
-          "moves": [],
-          "steps": [],
-          "summary": "Close the note."
-        },
-        "create": {
-          "moves": [],
-          "steps": [],
-          "summary": "File the note."
-        }
-      },
-      "fields": {
-        "reference": {
-          "type": "string"
-        }
-      },
-      "id": "note",
-      "idPrefix": "note",
-      "lifecycle": {
-        "initial": "open",
-        "states": [
-          "open",
-          "closed"
-        ],
-        "transitions": {
-          "close": {
-            "from": [
-              "open"
-            ],
-            "to": "closed"
-          }
-        }
-      },
-      "required": [
-        "reference"
-      ],
-      "summary": "A note a tenant files and later closes.",
-      "title": "Note"
-    }
-  ],
-  "product": "minimal",
-  "subjects": [],
-  "title": "Minimal",
-  "udl": 1,
-  "version": 1
-}
-

package/conformance/evolution/version-required.next.udl

@@ -1,58 +0,0 @@
-{
-  "instruments": [
-    {
-      "actionOrder": [
-        "close",
-        "create"
-      ],
-      "actions": {
-        "close": {
-          "moves": [],
-          "steps": [],
-          "summary": "Close the note."
-        },
-        "create": {
-          "moves": [],
-          "steps": [],
-          "summary": "File the note."
-        }
-      },
-      "fields": {
-        "reference": {
-          "type": "string"
-        },
-        "memo": {
-          "type": "string"
-        }
-      },
-      "id": "note",
-      "idPrefix": "note",
-      "lifecycle": {
-        "initial": "open",
-        "states": [
-          "open",
-          "closed"
-        ],
-        "transitions": {
-          "close": {
-            "from": [
-              "open"
-            ],
-            "to": "closed"
-          }
-        }
-      },
-      "required": [
-        "reference"
-      ],
-      "summary": "A note a tenant files and later closes.",
-      "title": "Note"
-    }
-  ],
-  "product": "minimal",
-  "subjects": [],
-  "title": "Minimal",
-  "udl": 1,
-  "version": 1
-}
-

package/conformance/invalid/action-without-transition.expected.json

@@ -1,10 +0,0 @@
-{
-  "issues": [
-    {
-      "code": "UDL3001",
-      "path": "$.instruments[0].actions.touch"
-    }
-  ],
-  "summary": "Every action but create moves the instance between declared states.",
-  "verdict": "invalid"
-}

package/conformance/invalid/action-without-transition.udl

@@ -1,60 +0,0 @@
-{
-  "instruments": [
-    {
-      "fields": {
-        "reference": {
-          "type": "string"
-        }
-      },
-      "id": "note",
-      "idPrefix": "note",
-      "lifecycle": {
-        "initial": "open",
-        "states": [
-          "open",
-          "closed"
-        ],
-        "transitions": {
-          "close": {
-            "from": [
-              "open"
-            ],
-            "to": "closed"
-          }
-        }
-      },
-      "required": [
-        "reference"
-      ],
-      "summary": "A note a tenant files and later closes.",
-      "title": "Note",
-      "actionOrder": [
-        "close",
-        "create",
-        "touch"
-      ],
-      "actions": {
-        "close": {
-          "moves": [],
-          "steps": [],
-          "summary": "Close the note."
-        },
-        "create": {
-          "moves": [],
-          "steps": [],
-          "summary": "File the note."
-        },
-        "touch": {
-          "moves": [],
-          "steps": [],
-          "summary": "Touch the note."
-        }
-      }
-    }
-  ],
-  "product": "minimal",
-  "subjects": [],
-  "title": "Minimal",
-  "udl": 1,
-  "version": 1
-}

package/conformance/invalid/agent-description-too-long.expected.json

@@ -1,10 +0,0 @@
-{
-  "issues": [
-    {
-      "code": "UDL1003",
-      "path": "$.instruments[0].actions.create.agentDescription"
-    }
-  ],
-  "summary": "Agent-facing prose is capped at 400 characters so a tool list stays inside a client's pick budget.",
-  "verdict": "invalid"
-}

package/conformance/invalid/agent-description-too-long.udl

@@ -1,57 +0,0 @@
-{
-  "instruments": [
-    {
-      "actionOrder": [
-        "close",
-        "create"
-      ],
-      "actions": {
-        "close": {
-          "agentDescription": "Close a note that has already been filed. Takes the note id and nothing else, and moves no money.",
-          "moves": [],
-          "steps": [],
-          "summary": "Close the note."
-        },
-        "create": {
-          "agentDescription": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
-          "moves": [],
-          "steps": [],
-          "summary": "File the note."
-        }
-      },
-      "agentDescription": "A filed note. Read it to recover the reference an operator recorded, and close it when the matter it tracks is settled.",
-      "fields": {
-        "reference": {
-          "type": "string"
-        }
-      },
-      "id": "note",
-      "idPrefix": "note",
-      "lifecycle": {
-        "initial": "open",
-        "states": [
-          "open",
-          "closed"
-        ],
-        "transitions": {
-          "close": {
-            "from": [
-              "open"
-            ],
-            "to": "closed"
-          }
-        }
-      },
-      "required": [
-        "reference"
-      ],
-      "summary": "A note a tenant files and later closes.",
-      "title": "Note"
-    }
-  ],
-  "product": "minimal",
-  "subjects": [],
-  "title": "Minimal",
-  "udl": 1,
-  "version": 1
-}

package/conformance/invalid/blank-title.expected.json

@@ -1,10 +0,0 @@
-{
-  "issues": [
-    {
-      "code": "UDL1003",
-      "path": "$.title"
-    }
-  ],
-  "summary": "Whitespace is not a title. JSON Schema cannot express this check, so it lives here.",
-  "verdict": "invalid"
-}