@agentshouse/mdmodel 0.1.0-c83456e1cebfb → 0.1.0-cabd61587647f

package/fixtures/README.md

@@ -27,7 +27,7 @@ validation Libraries. It carries `schema`, one schema text, and `cases`. Each
 case carries `name`, the `file` the Document sits at, exact `source`, the
 `documentTargets` the collection holds as Markdown documents, the `definition`
 type name or `null`, an optional `move`, an optional `links` inventory, an
-optional `relabel`, and `expected`.
+optional `relabel`, an optional `filtered`, and `expected`.
 A case carrying a `move` lists both the Path its target sits at and the Path the
 move takes it to, because the collection holds that target either way.
 
@@ -41,7 +41,11 @@ moved Path rewrites destinations and leaves the projection alone. Where
 `relabel` is present, split the source at its `from`, which the source carries
 exactly once, join the pieces with its `to`, parse the result, and confirm its
 projection is exactly the relabel's own `expected` and differs from the case's:
-a changed visible label changes the projection.
+a changed visible label changes the projection. Where `filtered` is present,
+apply `{ kind: 'field', name: field, value, prior }` with its `field` and
+`value` and the Document's current value as `prior`, confirm the serialized
+Document changed, and confirm its projection is still exactly `expected`: a
+change to a value that is not prose leaves the projection alone.
 
 ## Division
 
@@ -75,56 +79,63 @@ Refusal:
 {
   "verdict": "refuse",
   "file": "<library path>",
-  "location": "<field or section name>",
+  "location": "<JSON Pointer or section name>",
   "rule": "<rule id>",
   "referrers": ["<library path>"]
 }
 ```
 
-`location` is omitted when the rule is not about a field or section.
-`referrers` is present only for `referenced-missing-file`. A schema refusal
-carries no `file`; its `location`, when present, is the dotted path of the
-schema part it concerns, such as `types.task.fields.title`, or `line <n>` for
-`schema-yaml`.
+`location` is the JSON Pointer of the frontmatter value a rule concerns, such
+as `/shipping/city`, or the name of the section it concerns, and is omitted when
+the rule concerns neither. `referrers` is present only for
+`referenced-missing-file`. A schema refusal carries no `file`; its `location`
+is the JSON Pointer of the schema part it concerns, such as
+`/task/properties/title/type`, or `line <n>` for `schema-yaml`.
 
 ## Rule ids
 
-| Rule                      | When                                                                             |
-| ------------------------- | -------------------------------------------------------------------------------- |
-| `binary-target-document`  | A path is declared as both a text Document and a binary target                   |
-| `frontmatter-fence`       | A present frontmatter fence does not parse as the accepted YAML subset           |
-| `schema-yaml`             | A schema text is not a mapping in the accepted YAML subset                       |
-| `schema-shape`            | A schema is not a mapping of exactly `types` to a mapping of non-empty names     |
-| `schema-member-document`  | A second type is marked `member_document: true`                                  |
-| `definition-shape`        | A type is not a mapping of `fields`, `sections`, and a boolean `member_document` |
-| `definition-fields`       | `fields` is not a mapping                                                        |
-| `definition-field`        | A field spec is not an object of the accepted keys                               |
-| `definition-field-kind`   | A field kind is not text, string, number, date, enum, reference, or list         |
-| `definition-enum-values`  | An enum field has no non-empty string `values`                                   |
-| `definition-reference-to` | A reference has no `to` naming `any` or a type of the same schema                |
-| `definition-list-of`      | A list field or list section has no `of` that is one scalar kind                 |
-| `definition-sections`     | `sections` is not a mapping                                                      |
-| `definition-section`      | A section spec is not an object of the accepted keys                             |
-| `definition-section-kind` | A section kind is not `text` or `list`                                           |
-| `unknown-type`            | A file declares a type absent from the governing schema                          |
-| `required-field`          | A required field is missing                                                      |
-| `required-section`        | A required section heading is missing                                            |
-| `field-kind`              | A field value fails its kind, including date                                     |
-| `field-enum`              | A field value is not one of the declared enum values                             |
-| `undeclared-field`        | A typed file carries a frontmatter field its type does not declare               |
-| `unresolved-reference`    | A reference field or item resolves to no current file of the required type       |
-| `unresolved-link`         | A relative body link does not resolve to a current path                          |
-| `structured-section`      | A declared list section is not a list of its declared item kind                  |
-| `referenced-missing-file` | Remaining files still reference an absent path                                   |
-| `unwritable-link`         | No Markdown destination form can carry a new link destination                    |
-| `division-budget`         | A division budget is not a whole number of at least 2                            |
+A frontmatter value that fails a JSON Schema keyword is refused under that
+keyword's name, such as `required`, `type`, `enum`, `format`, `pattern`,
+`minimum`, `maxLength`, `maxItems` or `oneOf`, at the value's JSON Pointer; a
+missing required key is named by the Pointer it would sit at. A malformed
+schema keyword is refused under that keyword's name at its Pointer in the
+schema text. The model's own rules:
+
+| Rule                      | When                                                                              |
+| ------------------------- | --------------------------------------------------------------------------------- |
+| `binary-target-document`  | A path is declared as both a text Document and a binary target                    |
+| `frontmatter-fence`       | A present frontmatter fence does not parse as the accepted YAML subset            |
+| `schema-yaml`             | A schema text is not a mapping in the accepted YAML subset                        |
+| `schema-type-name`        | A type name is empty, starts with `$`, or is `any` or `attachment`                |
+| `schema`                  | A type or subschema is neither a mapping nor a boolean                            |
+| `schema-keyword`          | A schema carries a key that is no JSON Schema 2020-12 keyword the model admits    |
+| `$defs`                   | `$defs` is not a mapping                                                          |
+| `$ref`                    | A `$ref` reaches no subschema under `#/$defs/` of the same file                   |
+| `reference`               | `reference` is not on a string or names something but a type, `any`, `attachment` |
+| `sections`                | A section is not `{ kind: text }` or `{ kind: list, items }` over one scalar      |
+| `member_document`         | The mark is not a boolean, or a second type carries it                            |
+| `unknown-type`            | A file declares a type absent from the governing schema                           |
+| `undeclared-field`        | A closed object carries a key it does not declare                                 |
+| `required-section`        | A required section heading is missing                                             |
+| `unresolved-reference`    | A reference at any depth or a section item reaches no member it admits            |
+| `unresolved-link`         | A body link is an absolute path or leaves the collection                          |
+| `structured-section`      | A declared list section is not a list of values of its item schema                |
+| `referenced-missing-file` | Remaining files still reference an absent path                                    |
+| `unwritable-link`         | No Markdown destination form can carry a new link destination                     |
+| `division-budget`         | A division budget is not a whole number of at least 2                             |
 
 `unwritable-link` is refused by `apply` and `division-budget` by `divide`, not
 by `validate`, so no case under `cases/` carries either.
 
+A reference that admits `attachment` reaches any path in the same Library, so
+neither `unresolved-reference` for an absent target nor
+`referenced-missing-file` ever names it. A body link to an absent path in the
+Library is accepted too, so `unresolved-link` never names it and
+`referenced-missing-file` never counts it.
+
 ## YAML subset
 
 Frontmatter and a schema text are each a mapping in a closed YAML subset: block and flow mappings,
-block and flow sequences, plain and quoted scalars, `true`, `false`, `null`,
+block and flow sequences, a block sequence item that opens a mapping, plain and quoted scalars (a single-quoted scalar doubles its apostrophe, a double-quoted one takes JSON's escapes), `true`, `false`, `null`,
 and decimal numbers. It does not take YAML 1.1 boolean or timestamp aliases,
 octal numbers, anchors, tags, or block scalars. A mapping carries each key once.

package/fixtures/cases/absent-link-dangles/context.json

@@ -0,0 +1 @@
+{ "binaryTargets": [] }

package/fixtures/cases/absent-link-dangles/expected.json

@@ -0,0 +1 @@
+{ "verdict": "accept" }

package/fixtures/cases/absent-link-dangles/library/item.md

@@ -0,0 +1,8 @@
+---
+type: task
+title: Ship
+---
+
+## Description
+
+See [plan](missing.md).

package/fixtures/cases/absent-link-dangles/schema.yaml

@@ -0,0 +1,6 @@
+task:
+  properties:
+    title: { type: string }
+  required: [title]
+  sections:
+    Description: { kind: text, required: true }

package/fixtures/cases/absent-optional-field/context.json

@@ -0,0 +1 @@
+{ "binaryTargets": [] }

package/fixtures/cases/absent-optional-field/expected.json

@@ -0,0 +1 @@
+{ "verdict": "accept" }

package/fixtures/cases/absent-optional-field/library/companies/acme.md

@@ -0,0 +1,4 @@
+---
+type: company
+name: Acme
+---

package/fixtures/cases/absent-optional-field/library/deals/lead.md

@@ -0,0 +1,6 @@
+---
+type: deal
+title: Lead
+company: ../companies/acme.md
+stage: lead
+---

package/fixtures/cases/absent-optional-field/schema.yaml

@@ -0,0 +1,56 @@
+$defs:
+  address:
+    type: object
+    properties:
+      city: { type: string }
+      country: { type: string, pattern: '^[A-Z]{2}$' }
+    required: [city]
+company:
+  properties:
+    name: { type: string }
+deal:
+  type: object
+  properties:
+    title: { type: string, minLength: 1, maxLength: 40 }
+    company: { type: string, reference: company }
+    stage: { enum: [lead, proposal, won, lost], default: lead }
+    amount: { type: integer, minimum: 0 }
+    probability: { type: number, minimum: 0, maximum: 1 }
+    open: { type: boolean }
+    closes_at: { type: string, format: date-time }
+    contact_email: { type: string, format: email }
+    note: { type: [string, 'null'] }
+    shipping: { $ref: '#/$defs/address' }
+    tags: { type: array, items: { type: string }, maxItems: 3 }
+    lines:
+      type: array
+      items:
+        type: object
+        properties:
+          product: { type: string }
+          quantity: { type: integer, minimum: 1 }
+        required: [product, quantity]
+    blocks:
+      type: array
+      items:
+        oneOf:
+          - properties:
+              kind: { const: paragraph }
+              text: { type: string }
+            required: [kind, text]
+          - properties:
+              kind: { const: quiz }
+              question: { type: string }
+            required: [kind, question]
+    attributes:
+      type: object
+      additionalProperties: { type: string }
+  required: [title, company, stage]
+  if:
+    properties:
+      stage: { const: won }
+    required: [stage]
+  then:
+    required: [amount]
+  sections:
+    Description: { kind: text }

package/fixtures/cases/absolute-link/context.json

@@ -0,0 +1 @@
+{ "binaryTargets": [] }

package/fixtures/cases/{missing-binary-image → absolute-link}/expected.json

@@ -1,5 +1,5 @@
 {
   "verdict": "refuse",
-  "file": "notes/draft.md",
+  "file": "item.md",
   "rule": "unresolved-link"
 }

package/fixtures/cases/absolute-link/library/item.md

@@ -0,0 +1,8 @@
+---
+type: task
+title: Ship
+---
+
+## Description
+
+See [plan](/notes/plan.md).

package/fixtures/cases/absolute-link/schema.yaml

@@ -0,0 +1,6 @@
+task:
+  properties:
+    title: { type: string }
+  required: [title]
+  sections:
+    Description: { kind: text, required: true }

package/fixtures/cases/attachment-reference-any-file/context.json

@@ -0,0 +1 @@
+{ "binaryTargets": [] }

package/fixtures/cases/attachment-reference-any-file/expected.json

@@ -0,0 +1 @@
+{ "verdict": "accept" }

package/fixtures/cases/attachment-reference-any-file/library/companies/acme.md

@@ -0,0 +1,4 @@
+---
+type: company
+name: Acme
+---

package/fixtures/cases/attachment-reference-any-file/library/deals/renewal.md

@@ -0,0 +1,15 @@
+---
+type: deal
+title: Renewal
+company: ../companies/acme.md
+shipping:
+  city: Paris
+  depot: ../places/depot.md
+lines:
+  - product: ../products/seats.md
+    quantity: 10
+  - { product: ../products/support.md, quantity: 1 }
+contract: ../products/seats.md
+---
+
+The yearly renewal.

package/fixtures/cases/attachment-reference-any-file/library/places/depot.md

@@ -0,0 +1,4 @@
+---
+type: place
+name: Depot
+---

package/fixtures/cases/attachment-reference-any-file/library/products/seats.md

@@ -0,0 +1,4 @@
+---
+type: product
+name: Seats
+---

package/fixtures/cases/attachment-reference-any-file/library/products/support.md

@@ -0,0 +1,4 @@
+---
+type: product
+name: Support
+---

package/fixtures/cases/attachment-reference-any-file/schema.yaml

@@ -0,0 +1,32 @@
+$defs:
+  address:
+    type: object
+    properties:
+      city: { type: string }
+      depot: { type: string, reference: place }
+    required: [city]
+company:
+  properties:
+    name: { type: string }
+product:
+  properties:
+    name: { type: string }
+place:
+  properties:
+    name: { type: string }
+deal:
+  type: object
+  properties:
+    title: { type: string }
+    company: { type: string, reference: company }
+    shipping: { $ref: '#/$defs/address' }
+    lines:
+      type: array
+      items:
+        type: object
+        properties:
+          product: { type: string, reference: product }
+          quantity: { type: integer, minimum: 1 }
+        required: [product, quantity]
+    contract: { type: string, reference: attachment }
+  required: [title, company]

package/fixtures/cases/attachment-reference-dangles/context.json

@@ -0,0 +1 @@
+{ "binaryTargets": [] }

package/fixtures/cases/attachment-reference-dangles/expected.json

@@ -0,0 +1 @@
+{ "verdict": "accept" }

package/fixtures/cases/attachment-reference-dangles/library/companies/acme.md

@@ -0,0 +1,4 @@
+---
+type: company
+name: Acme
+---

package/fixtures/cases/attachment-reference-dangles/library/deals/renewal.md

@@ -0,0 +1,15 @@
+---
+type: deal
+title: Renewal
+company: ../companies/acme.md
+shipping:
+  city: Paris
+  depot: ../places/depot.md
+lines:
+  - product: ../products/seats.md
+    quantity: 10
+  - { product: ../products/support.md, quantity: 1 }
+contract: ../assets/contract.pdf
+---
+
+The yearly renewal.

package/fixtures/cases/attachment-reference-dangles/library/places/depot.md

@@ -0,0 +1,4 @@
+---
+type: place
+name: Depot
+---

package/fixtures/cases/attachment-reference-dangles/library/products/seats.md

@@ -0,0 +1,4 @@
+---
+type: product
+name: Seats
+---

package/fixtures/cases/attachment-reference-dangles/library/products/support.md

@@ -0,0 +1,4 @@
+---
+type: product
+name: Support
+---

package/fixtures/cases/attachment-reference-dangles/schema.yaml

@@ -0,0 +1,32 @@
+$defs:
+  address:
+    type: object
+    properties:
+      city: { type: string }
+      depot: { type: string, reference: place }
+    required: [city]
+company:
+  properties:
+    name: { type: string }
+product:
+  properties:
+    name: { type: string }
+place:
+  properties:
+    name: { type: string }
+deal:
+  type: object
+  properties:
+    title: { type: string }
+    company: { type: string, reference: company }
+    shipping: { $ref: '#/$defs/address' }
+    lines:
+      type: array
+      items:
+        type: object
+        properties:
+          product: { type: string, reference: product }
+          quantity: { type: integer, minimum: 1 }
+        required: [product, quantity]
+    contract: { type: string, reference: attachment }
+  required: [title, company]

package/fixtures/cases/attachment-reference-outside/context.json

@@ -0,0 +1 @@
+{ "binaryTargets": [] }

package/fixtures/cases/attachment-reference-outside/expected.json

@@ -0,0 +1,6 @@
+{
+  "verdict": "refuse",
+  "file": "deals/renewal.md",
+  "location": "/contract",
+  "rule": "unresolved-reference"
+}

package/fixtures/cases/attachment-reference-outside/library/companies/acme.md

@@ -0,0 +1,4 @@
+---
+type: company
+name: Acme
+---

package/fixtures/cases/attachment-reference-outside/library/deals/renewal.md

@@ -0,0 +1,15 @@
+---
+type: deal
+title: Renewal
+company: ../companies/acme.md
+shipping:
+  city: Paris
+  depot: ../places/depot.md
+lines:
+  - product: ../products/seats.md
+    quantity: 10
+  - { product: ../products/support.md, quantity: 1 }
+contract: /rooms/other/assets/contract.pdf
+---
+
+The yearly renewal.

package/fixtures/cases/attachment-reference-outside/library/places/depot.md

@@ -0,0 +1,4 @@
+---
+type: place
+name: Depot
+---

package/fixtures/cases/attachment-reference-outside/library/products/seats.md

@@ -0,0 +1,4 @@
+---
+type: product
+name: Seats
+---

package/fixtures/cases/attachment-reference-outside/library/products/support.md

@@ -0,0 +1,4 @@
+---
+type: product
+name: Support
+---

package/fixtures/cases/attachment-reference-outside/schema.yaml

@@ -0,0 +1,32 @@
+$defs:
+  address:
+    type: object
+    properties:
+      city: { type: string }
+      depot: { type: string, reference: place }
+    required: [city]
+company:
+  properties:
+    name: { type: string }
+product:
+  properties:
+    name: { type: string }
+place:
+  properties:
+    name: { type: string }
+deal:
+  type: object
+  properties:
+    title: { type: string }
+    company: { type: string, reference: company }
+    shipping: { $ref: '#/$defs/address' }
+    lines:
+      type: array
+      items:
+        type: object
+        properties:
+          product: { type: string, reference: product }
+          quantity: { type: integer, minimum: 1 }
+        required: [product, quantity]
+    contract: { type: string, reference: attachment }
+  required: [title, company]

package/fixtures/cases/binary-any-reference/expected.json

@@ -2,5 +2,5 @@
   "verdict": "refuse",
   "file": "notes/draft.md",
   "rule": "unresolved-reference",
-  "location": "subject"
+  "location": "/subject"
 }

package/fixtures/cases/binary-any-reference/schema.yaml

@@ -1,4 +1,4 @@
-types:
-  note:
-    fields:
-      subject: { kind: reference, to: any, required: true }
+note:
+  properties:
+    subject: { type: string, reference: any }
+  required: [subject]

package/fixtures/cases/binary-document-collision/schema.yaml

@@ -1,2 +1 @@
-types:
-  note: {}
+note: {}

package/fixtures/cases/binary-image-dangles/expected.json

@@ -0,0 +1 @@
+{ "verdict": "accept" }

package/fixtures/cases/binary-image-dangles/schema.yaml

@@ -0,0 +1 @@
+note: {}

package/fixtures/cases/binary-link-dangles/expected.json

@@ -0,0 +1 @@
+{ "verdict": "accept" }

package/fixtures/cases/binary-link-dangles/schema.yaml

@@ -0,0 +1 @@
+note: {}

package/fixtures/cases/binary-link-outside-collection/schema.yaml

@@ -1,2 +1 @@
-types:
-  note: {}
+note: {}

package/fixtures/cases/binary-prototype-reference/expected.json

@@ -2,5 +2,5 @@
   "verdict": "refuse",
   "file": "notes/draft.md",
   "rule": "unresolved-reference",
-  "location": "subject"
+  "location": "/subject"
 }

package/fixtures/cases/binary-prototype-reference/schema.yaml

@@ -1,4 +1,4 @@
-types:
-  note:
-    fields:
-      subject: { kind: reference, to: any, required: true }
+note:
+  properties:
+    subject: { type: string, reference: any }
+  required: [subject]

package/fixtures/cases/binary-typed-reference/expected.json

@@ -2,5 +2,5 @@
   "verdict": "refuse",
   "file": "notes/draft.md",
   "rule": "unresolved-reference",
-  "location": "subject"
+  "location": "/subject"
 }

package/fixtures/cases/binary-typed-reference/schema.yaml

@@ -1,5 +1,5 @@
-types:
-  note:
-    fields:
-      subject: { kind: reference, to: person, required: true }
-  person: {}
+note:
+  properties:
+    subject: { type: string, reference: person }
+  required: [subject]
+person: {}

package/fixtures/cases/boolean-field/context.json

@@ -0,0 +1 @@
+{ "binaryTargets": [] }

package/fixtures/cases/boolean-field/expected.json

@@ -0,0 +1,6 @@
+{
+  "verdict": "refuse",
+  "file": "deals/renewal.md",
+  "location": "/open",
+  "rule": "type"
+}

package/fixtures/cases/boolean-field/library/companies/acme.md

@@ -0,0 +1,4 @@
+---
+type: company
+name: Acme
+---

package/fixtures/cases/boolean-field/library/deals/renewal.md

@@ -0,0 +1,31 @@
+---
+type: deal
+title: Renewal
+company: ../companies/acme.md
+stage: won
+amount: 1200
+probability: 0.5
+open: "no"
+closes_at: 2026-10-10T09:30:00Z
+contact_email: ana@example.com
+note: null
+shipping:
+  city: Paris
+  country: FR
+tags: [renewal, priority]
+lines:
+  - product: seats
+    quantity: 10
+  - product: support
+    quantity: 1
+blocks:
+  - kind: paragraph
+    text: Signed.
+  - { kind: quiz, question: Renew next year? }
+attributes:
+  region: emea
+---
+
+## Description
+
+The yearly renewal.