@agentshouse/mdmodel 0.1.0-c83456e1cebfb → 0.1.0-c896b3d9398b1

package/API.md

@@ -16,26 +16,16 @@ import {
   VERSION,
 } from '@agentshouse/mdmodel';
 
-validate({ 'note.md': '# Hello\n' });
-const checked = verify('types:\n  task:\n    fields:\n      title: { kind: string }\n');
+const checked = verify('task:\n  properties:\n    title: { type: string }\n');
 if (checked.verdict === 'accept') {
   validate(
     { 'tasks/one.md': '---\ntype: task\ntitle: Ship\n---\n![Figure](assets/figure.png)\n' },
     { binaryTargets: ['assets/figure.png'] },
     checked.model,
   );
-  const task = checked.model.types.task;
-  const titleKind = task?.fields.title?.kind;
 }
 const parsed = parse(content);
 if (parsed.ok) {
-  const next = apply(parsed.document, {
-    kind: 'field',
-    name: 'title',
-    value: 'World',
-    prior: 'Hello',
-  });
-  if (next.outcome === 'applied') serialize(next.document);
   for (const link of links(parsed.document, 'tasks/two.md')) {
     if (link.target !== 'data/export.csv') continue;
     const moved = apply(parsed.document, {
@@ -48,56 +38,75 @@ if (parsed.ok) {
 }
 ```
 
-`verify(schema)` reads one schema text, the MD Types of one Room or App, and
-returns a verified model whose `types` expose each MD Type's `name`,
-`memberDocument` flag, parsed field specs, and declared sections. The text is a
-YAML mapping in the frontmatter subset whose one key, `types`, maps each MD Type
-name to an entry of optional `fields`, `sections`, and boolean `member_document`:
+`MARKDOWN_SYNTAX_PROFILE` is the Markdown every reader here applies, GitHub Flavored Markdown
+0.29, and `VERSION` is the MD model version.
+
+`verify(schema)` reads one schema text, the MD Types of one Room or App: one
+JSON Schema document (draft 2020-12) in the YAML subset. Every top-level key but
+`$defs` names an MD Type holding the JSON Schema of its frontmatter; `$defs`
+holds shapes the types reuse, reached by a `$ref` under `#/$defs/` alone. `type`
+and the built-in `any` are never declared. The model adds three keywords:
+`reference` on a string names one MD Type, several, `any` or `attachment`;
+`sections` declares a type's H2 sections, each `{ kind: text }` or `{ kind:
+list, items }` over one string, number, integer or boolean, optionally
+`required: true`; `member_document: true` marks at most one type.
 
 ```yaml
-types:
-  plan:
-    fields:
-      title: { kind: string, required: true }
-      status: { kind: enum, values: [active, done] }
-      owner: { kind: reference, to: contact }
-    sections:
-      Goals: { kind: text }
-  contact:
-    member_document: true
-    fields:
-      name: { kind: string, required: true }
+$defs:
+  address: { type: object, properties: { city: { type: string } }, required: [city] }
+plan:
+  properties:
+    status: { enum: [active, done] }
+    owner: { type: string, reference: contact }
+    shipping: { $ref: '#/$defs/address' }
+  required: [status]
+  sections: { Goals: { kind: text, required: true } }
+contact: { member_document: true }
 ```
 
-A field spec names its `kind` and `required` flag; a list carries `of`, an enum
-carries `values`, and a reference carries `to`, which names `any` or a type of
-the same schema. At most one type is marked `member_document: true`. A
-malformed schema is refused whole, naming its `rule` and, where the
-rule concerns one part of the text, its `location`: a dotted path such as
-`types.plan.fields.status`, or `line <n>` where the text leaves the YAML subset.
+The model's `types` expose each MD Type's `name`, `memberDocument`, `sections`,
+`shape` (the type as written with every `$defs` shape it reaches), the facts of
+its `frontmatter` and `fields`, its top-level ones: JSON `type`, `format`,
+`values`, `reference` targets, `items`, `properties`, an open map's `patterns`
+and `additional`, and `prose`, a string with no `enum`, `const`, `format`,
+`pattern` or `reference`. Facts join `$ref` and `allOf` to their siblings and
+the variants of `anyOf`, `oneOf`, `then`, `else` and `dependentSchemas`, a
+variant's own keys `conditional`; a path without one `type`, `null` aside, has
+none. A malformed schema is refused whole, naming its `rule`, the keyword or the
+model's own, and the JSON Pointer `location` it concerns, such as
+`/plan/properties/status/enum`, or `line <n>` outside the YAML subset.
+`pointerFacts(definition, pointer)` reads the facts a frontmatter pointer reaches,
+`itemFacts` and `memberFacts` take one step and `crossedFacts` reads a list's item
+facts; `pointerSegments` and `escapePointer` split and write a pointer, `ARRAY_INDEX`
+matches an index segment, and `ATTACHMENT` is the `reference` that admits any path.
 
 `validate(library, context?, model?)` takes the resulting text Library and one
-`ValidationContext` containing `binaryTargets: readonly string[]`. Omitting the
-context declares no binary targets. Library keys and binary targets use the
-same collection-relative path namespace; callers supply canonical paths, and
-a path declared as both text and binary is refused. Ordinary links and images
-in typed Documents may resolve to either membership, including relative
-normalization from the source Document. A binary target supplies no Document
-or MD Type and cannot satisfy a typed reference, including one to `any`.
-The existing `any` Document rules are unchanged.
-`model` is the verified schema that types the Library, and every Library member
-is content, whatever its Path. Without `model` the Library declares no type.
-
-A typed Document carries the frontmatter fields its MD type declares, plus
-`type`, `SITE_FIELD` and `RECEIVED_FIELD`, the `site` and `received` a Site
-submission adds; a Document of the type marked `member_document` also carries
-`MEMBER_FIELD`, `member`, a string, unless that type declares it. Any other field is refused as `undeclared-field` at that field name. A field
-name YAML carries to a record prototype, `__proto__` among them, is an ordinary
-undeclared field and is refused as one. Every occurrence of a declared list section is a list
-whose every item is one value of its declared item kind, or it is refused as `structured-section`.
-A free-text or string item is any text; a number, date, or enum item is that value alone, such
-as `- 3`; a reference item is one ordinary link alone, such as `- [Ada](ada.md)`, refused as
-`unresolved-reference` where it reaches a binary target, a URL, or another MD type's Document.
+`ValidationContext` of `binaryTargets: readonly string[]`, none when omitted.
+Library keys and binary targets share one canonical collection-relative path
+namespace; a path declared text and binary is refused. House declares every
+binary file of the Room as a binary target, and the model reads no bytes. Ordinary links and images
+in typed Documents may resolve to either membership, relative to the source
+Document, and one to a path neither holds is not refused: it dangles, as a
+deleted file's links do. A destination that is an absolute path or leaves the
+collection is `unresolved-link`. A binary target supplies no Document or MD Type. `model` is the
+verified schema that types the Library, and every Library member is content,
+whatever its Path. Without `model` the Library declares no type.
+
+A typed Document's frontmatter satisfies its type's schema, every keyword with
+its JSON Schema meaning, formats asserted and defaults never filled, except that
+an object schema declaring neither `additionalProperties` nor
+`unevaluatedProperties` is closed: an undeclared key is refused as `undeclared-
+field`. `type`, `SITE_FIELD` and `RECEIVED_FIELD` count as declared on every
+type, and the string `MEMBER_FIELD` on the `member_document` type. A refusal
+names the keyword, such as `required`, and the value's JSON Pointer, such as
+`/shipping/city`. Every occurrence of a declared list section is a list of
+values of its item schema, else `structured-section`; a reference item is one
+ordinary link alone, such as `- [Ada](ada.md)`. A reference, at any depth or a
+section item, reaching a URL, a binary target, or a Document of a type it does
+not name is `unresolved-reference`, and a frontmatter one reaching no member is
+`referenced-missing-file` naming its `referrers`; `attachment` admits any path,
+and no body link is a referrer.
+
 Validation returns acceptance or one refusal naming the file, the field or
 section, and the violated rule. `parse`, `apply`, and `serialize` operate on a single text
 Document; they do not validate collection membership or consume binary bytes.
@@ -137,67 +146,66 @@ no newline or separator is inserted, and the resulting source is parsed again.
 An invalid frontmatter result receives the existing parse refusal. Independent
 field, section, and preamble edits keep their own prior values valid.
 
-For a moved link, use `links` and the `link` change below to obtain the rewritten
-Document, then compare its public `preamble` and `sections` to the original.
-Submit the changed values with their original priors. Consumers need no source
-span calculation or private Model import. Collection validation remains a
-separate call against the resulting Library.
-
-`links(document, file)` is the inventory of that Document's ordinary link and
-image destinations that resolve to a collection Path, each with the destination
-`href` exactly as written and the `target` Path it resolves to relative to
-`file`. A `?query` or `#fragment` the destination carries is part of `href` and
-not part of `target`. Entries are ordered by the position of the destination
-text a rewrite would change, and one destination written the same way appears
-once however many times it occurs. A destination that the syntax profile does not read as a
-link, one that is empty, a bare fragment, or carries a URL scheme, and one that
-leaves the collection are not in the inventory. Frontmatter field values,
-including typed references, are not link destinations and are never enumerated.
-
-`target(file, href)` is the collection Path one written destination resolves to
-relative to `file`, by the rule `links` and `validate` read: surrounding spaces
-and the `?query` or `#fragment` it carries are not part of that Path. A
-destination that is empty, a bare fragment, carries a URL scheme, starts at `/`,
-or leaves the collection resolves to `null`. It reads a destination written
-anywhere, such as a typed reference field value, which `links` never
-enumerates. `retarget(href, to)` is that destination rewritten to `to`, keeping
-the `?query` or `#fragment` it carried, which is the destination the `link`
-change below writes.
+For a moved link, use `links` and the `link` change below to obtain the rewritten Document, then
+compare its public `preamble` and `sections` to the original. Submit the changed values with their
+original priors. Consumers need no source span calculation or private Model import. Collection
+validation remains a separate call against the resulting Library.
+
+`links(document, file)` is the inventory of that Document's ordinary link and image destinations
+that resolve to a collection Path, each with the destination `href` exactly as written and the
+`target` Path it resolves to relative to `file`. A `?query` or `#fragment` the destination carries
+is part of `href` and not part of `target`. Entries are ordered by the position of the destination
+text a rewrite would change, and one destination written the same way appears once however many
+times it occurs. A destination that the syntax profile does not read as a link, one that is empty,
+a bare fragment, or carries a URL scheme, and one that leaves the collection are not in the
+inventory. Frontmatter field values, including typed references, are not link destinations and
+are never enumerated.
+
+`target(file, href)` is the collection Path one written destination resolves to relative to
+`file`, by the rule `links` and `validate` read: surrounding spaces and the `?query` or `#fragment`
+it carries are not part of that Path. A destination that is empty, a bare fragment, carries a URL
+scheme, starts at `/`, or leaves the collection resolves to `null`. It reads a destination written
+anywhere, such as a typed reference field value, which `links` never enumerates.
+`retarget(href, to)` is that destination rewritten to `to`, keeping the `?query` or `#fragment` it
+carried, which is the destination the `link` change below writes.
+
+`references(document, definition)` lists each frontmatter `reference` string at any depth as
+`pointer`, `value` and `to`; `apply(document, { kind: 'reference', pointer, value, prior })`
+rewrites one in place, keeping its quotes, or is `stale`. `relativize(document, file, handle,
+definition?)` rewrites each link destination and reference written `/rooms/<handle>/<path>` to
+`relative(file, path)`, keeping its `?query` or `#fragment`. A text without frontmatter, such as
+a captured body, is read from its first character: `relativizeBody(body, file, handle)` converts
+it so, refusing a destination left under `/rooms/` as `unresolved-link`; `bodyLinks(body, file)`
+is its `links`; `relinkBody(body, file, moves)` writes, in one pass, each destination whose Path
+is a key of `moves` as relative to its value, in the form the `link` change below writes.
 
 ```ts
 target('items/six.md', ' ../projects/atlas.md#overview '); // 'projects/atlas.md'
 retarget(' ../projects/atlas.md#overview ', '../archive/atlas.md'); // '../archive/atlas.md#overview'
 ```
 
-`apply(document, { kind: 'link', href, to })` rewrites every body occurrence of
-that written destination and changes nothing else, so a caller that moves a Path
-rewrites its referring Documents without a second Markdown parser. `to` is the
-Path the destination must resolve to instead; the `?query` or `#fragment` the
-written destination carried is not part of that Path and is kept. A Document
-that does not carry the destination is `stale`. A reference definition is
-rewritten once however many uses name it. The destination is
-written in the form the syntax profile reads back: bare when it carries no
-whitespace, does not open with `<`, and balances its parentheses, otherwise
-inside angle brackets, which the original form is kept in when it still fits. A
-destination that neither form can carry is refused as `unwritable-link`.
+`apply(document, { kind: 'link', href, to })` rewrites every body occurrence of that written
+destination and changes nothing else, so a caller that moves a Path rewrites its referring
+Documents without a second Markdown parser. `to` is the Path the destination must resolve to
+instead; the `?query` or `#fragment` the written destination carried is not part of that Path and
+is kept. A Document that does not carry the destination is `stale`. A reference definition is
+rewritten once however many uses name it. The destination is written in the form the syntax
+profile reads back: bare when it carries no whitespace, does not open with `<`, and balances its
+parentheses, otherwise inside angle brackets, which the original form is kept in when it still
+fits. A destination that neither form can carry is refused as `unwritable-link`.
 
 `project(document, file, context?)` is the Embedding projection input of one
 Document: the prose a consumer embeds, with every internal Markdown-document
 link reduced to the label a reader sees. A Document that declares no MD type
-contributes its body after the frontmatter fence. A Document that declares one
-contributes its free-text field values, its preamble, and every H2 section its
-MD type does not declare as structure, each section with its own heading line
-and every occurrence of a repeated name, in the order the Document carries
-them. A declared free-text section, a declared list section whose items are
-free text, and a section the MD type does not declare at all are all inside
-that input; a declared list section of any other item kind is not, so
-eligibility follows the declared kind rather than the form the author wrote.
-Each free-text field value is projected bare, without its field name and
-followed by a blank line, in the order the MD Type declares its fields, and
-every item of a free-text list field is one such value, projected as the author
-wrote it: the link inventory reads the body, so link syntax inside a
-frontmatter value is text like any other. The Document's Path and its typed
-fields of every other kind stay outside that input.
+contributes its body after the frontmatter fence. A typed one contributes its
+prose values, its preamble, and every H2 section its MD type does not declare as
+structure, each with its own heading line and every occurrence of a repeated
+name, in Document order: a declared text section, a list section of prose items
+and an undeclared section are in; a list section of any other item schema is
+not. A prose value is a frontmatter string at any depth whose schema is prose,
+projected bare and followed by a blank line, in the order the Document writes
+them, exactly as written. The Path and every other value stay outside, so
+changing them alone leaves the projection unchanged.
 
 ```ts
 const parsed = parse(content);
@@ -216,7 +224,7 @@ Document's `type` names, taken from the model `verify` returned. A Document that
 declares a type the caller supplies no definition for is refused as
 `unknown-type`. `documentTargets` is what makes a destination internal: a
 destination resolving to a supplied Path is internal, and every other
-destination stays authored text, a retained binary target and a Path nobody
+destination stays authored text, a binary target and a Path nobody
 supplied alike. The caller supplies that membership, as it does for `validate`;
 the model reads no bytes, resolves no authority, and classifies nothing it was
 not given.
@@ -226,14 +234,13 @@ title, in the inline `[label](path)`, full `[label][id]`, collapsed
 `[label][]`, and shortcut `[label]` forms, and the link reference definition an
 enumerated use resolves through leaves the projection with it. An image at a
 supplied document target contributes its alt text the same way, because a move
-rewrites that destination too. External URLs, retained binary targets,
+rewrites that destination too. External URLs, binary targets,
 unsupplied destinations, bare fragments, code spans, fenced code, and escaped
 syntax stay exactly as authored, read through the same syntax profile `links`
 and `validate` read. `project` returns text and never rewrites the Document.
 
-Because a moved Path changes destinations alone, applying a `link` change leaves
-the projection of every Document it rewrites byte-identical, while a changed
-visible label changes it.
+A `link` change leaves the projection of every Document it rewrites
+byte-identical, while a changed visible label changes it.
 
 `divide(document, file, context)` divides that same Embedding projection input
 into ordered Spans under the budget the caller supplies. Each Span carries the
@@ -296,3 +303,53 @@ author quoted. A Span divided out of one free-text field value addresses that
 whole value, because a YAML scalar's own positions are the only ones its source
 has, and a Span carrying part of one internal link's label addresses that whole
 link, because a cut never falls inside link syntax.
+
+## Conditions
+
+`facts(document, { id, path }, model, resolve)` reads one Document as the `DocumentFacts` a
+condition tests: its `id`, its `path` with a leading `/`, its `type` or `null`, its `sections`, and
+a `Fact` for each frontmatter field it writes that its MD Type declares. `factKind(facts)` names
+the kind a declared value compares as: `reference`, `enum`, `number`, `boolean`, `date`, `time`
+(a `date-time`) or `string`, else `null`. A prose value, or one of no kind, is `prose`, a list or
+an object holds the facts of its members, and a value written `null` is `null`. A value that does
+not fit its kind, such as a string in a number field, a value outside its `enum` or a reference
+`resolve` maps to no `{ id, member? }`, is `unreadable`; a readable reference compares as that `id`.
+
+`holds(test, facts, owner)` is `true`, `false` or `undefined`, unknown; a Trigger fires on `true`
+alone. A test's `path` is `/path`, `/type`, `/sections/<heading>`, `/fields/<pointer>`, or
+`/members/<pointer>`, the member of the Document a reference field reaches. A pointer segment that
+is not an index reads every item of a list, an item lacking it unknown, and a test over several
+values holds as `any` does. The value `{ owner: true }` stands for `owner`, a User id.
+
+| The path reaches                        | `exists`    | `contains`     | any other test |
+| --------------------------------------- | ----------- | -------------- | -------------- |
+| a value                                 | present     | `undefined`    | compared       |
+| `null`, prose or a section              | present     | `undefined`    | `undefined`    |
+| a list                                  | present     | `any` of items | `undefined`    |
+| no item, through an empty list          | absent      | `false`        | `false`        |
+| nothing: no such field, section or type | absent      | `undefined`    | `undefined`    |
+| only unreadable values                  | `undefined` | `undefined`    | `undefined`    |
+
+`exists: true` holds where present and fails where absent, `exists: false` the reverse. `all` is
+`false` if a part is, else `undefined` if a part is; `any` is `true` if a part is, else `undefined`
+if a part is; `not` keeps `undefined`, so absence is tested with `exists`, never with `not`. `eq`
+and `in` are `undefined` against a value of another JSON type and compare a `time` as an instant;
+`prefix` reads only a string, never a reference or a member; `gt`, `gte`, `lt` and `lte` order
+numbers, dates and times alone.
+
+`fires(condition, event, owner)` reads one change, `{ before, after, changed, by }`: the facts of
+each side, `null` on the side a creation or a deletion lacks, the `changed` paths whose prose
+changed, and the actor whose `/user`, `/site` and `/door`, one of `WRITE_DOORS`, a `by` test reads.
+`starts_matching` fires when the Document is in `scope` and holds `match` after the change and did
+not before; a creation fires only with `new_documents: true`, and a deletion never fires.
+`field_changes` fires when the side the Document has, after or for a deletion before, is in `scope`
+and holds `match`, and `field` changed: its facts differ, or with neither `from` nor `to` `changed`
+names it. A field absent on both sides never fires; `from: 'new'` admits only a creation and
+`to: 'deleted'` only a deletion, and listed values need that side to hold `field` `in` them.
+
+`itemFires(condition, item, owner)` compares `source` and `address` where given and holds `match`
+over `/delivery`, `/source`, `/provider`, `/container`, `/author`, `/has_attachment`,
+`/headers/<name>` and `/json/<pointer>`, unknown for an item with no JSON. `prosePaths(facts)` lists
+the prose and section paths whose text builds `changed`; `pointed(value, pointer)` reads a JSON
+Pointer, `undefined` where nothing is; `dated(value)` checks a `YYYY-MM-DD` date, and
+`instant(value)` reads an RFC 3339 time with its offset as epoch nanoseconds, a `bigint`.

package/README.md

@@ -1,6 +1,6 @@
 # `@agentshouse/mdmodel`
 
-Typed Markdown documents: the MD Type language, a parser, a validator, and the
+Typed Markdown documents: MD Types declared in JSON Schema, a parser, a validator, and the
 deterministic application of one structured change to a Document, plus a
 conformance fixture corpus.
 
@@ -19,7 +19,7 @@ npm install @agentshouse/mdmodel
 ```ts
 import { apply, parse, serialize, validate, verify } from '@agentshouse/mdmodel';
 
-const checked = verify('types:\n  task:\n    fields:\n      title: { kind: string }\n');
+const checked = verify('task:\n  properties:\n    title: { type: string }\n');
 if (checked.verdict === 'accept') {
   validate({ 'tasks/one.md': '---\ntype: task\ntitle: Ship\n---\n' }, undefined, checked.model);
 }
@@ -45,7 +45,9 @@ if (parsed.ok) {
 | `parse`, `serialize`                           | Read and write one Document                                       |
 | `apply`                                        | Apply one field, section, preamble, or link change                |
 | `links`, `target`, `retarget`                  | Inventory and rewrite link destinations                           |
+| `escapePointer`                                | Write one key as a JSON Pointer token                             |
 | `project`, `divide`                            | Embedding projection input and its division into Spans            |
+| `facts`, `factKind`, `holds`, `fires`          | A condition over a Document and over one of its changes           |
 | `MARKDOWN_SYNTAX_PROFILE`, `VERSION`           | The pinned Markdown profile (GFM 0.29) and MD model version       |
 | `MEMBER_FIELD`, `SITE_FIELD`, `RECEIVED_FIELD` | The field names validation counts as declared beyond a type's own |
 

package/dist/condition.d.ts

@@ -0,0 +1,149 @@
+import { type ValueFacts } from './definition.js';
+import type { Document, VerifiedModel } from './types.js';
+export type ConditionValue = string | number | boolean | {
+    readonly owner: true;
+};
+export type ConditionTest = {
+    readonly all: readonly ConditionTest[];
+} | {
+    readonly any: readonly ConditionTest[];
+} | {
+    readonly not: ConditionTest;
+} | ({
+    readonly path: string;
+} & ({
+    readonly eq: ConditionValue;
+} | {
+    readonly in: readonly ConditionValue[];
+} | {
+    readonly exists: boolean;
+} | {
+    readonly contains: ConditionValue;
+} | {
+    readonly gt: number | string;
+} | {
+    readonly gte: number | string;
+} | {
+    readonly lt: number | string;
+} | {
+    readonly lte: number | string;
+} | {
+    readonly prefix: string;
+}));
+export type ConditionScope = {
+    readonly type: string;
+} | {
+    readonly folder: string;
+} | {
+    readonly document: string;
+};
+type DocumentEventBase = {
+    readonly on: 'documents';
+    readonly scope: ConditionScope;
+    readonly by?: ConditionTest;
+};
+export type DocumentCondition = (DocumentEventBase & {
+    readonly mode: 'starts_matching';
+    readonly new_documents: boolean;
+    readonly match: ConditionTest;
+}) | (DocumentEventBase & {
+    readonly mode: 'field_changes';
+    readonly field: string;
+    readonly from?: readonly ConditionValue[] | 'new';
+    readonly to?: readonly ConditionValue[] | 'deleted';
+    readonly match?: ConditionTest;
+});
+export type ItemCondition = {
+    readonly on: 'items';
+    readonly source?: string;
+    readonly address?: string;
+    readonly match?: ConditionTest;
+};
+export type CronCondition = {
+    readonly on: 'clock';
+    readonly cron: string;
+    readonly time_zone: string;
+};
+export type DateCondition = {
+    readonly on: 'clock';
+    readonly scope: {
+        readonly type: string;
+    };
+    readonly date: string;
+    readonly days: number;
+    readonly at: string;
+    readonly time_zone: string;
+    readonly match?: ConditionTest;
+};
+export type Condition = DocumentCondition | ItemCondition | CronCondition | DateCondition;
+export type FactKind = 'string' | 'number' | 'boolean' | 'date' | 'time' | 'enum' | 'reference';
+type Scalar = string | number | boolean;
+export type Fact = {
+    readonly kind: FactKind;
+    readonly value: Scalar;
+    readonly member?: string;
+} | {
+    readonly kind: 'prose';
+} | {
+    readonly kind: 'null';
+} | {
+    readonly kind: 'unreadable';
+} | {
+    readonly kind: 'list';
+    readonly items: readonly Fact[];
+} | {
+    readonly kind: 'object';
+    readonly fields: Readonly<Record<string, Fact>>;
+};
+export type DocumentFacts = {
+    readonly id: string;
+    readonly path: string;
+    readonly type: string | null;
+    readonly fields: Readonly<Record<string, Fact>>;
+    readonly sections: readonly string[];
+};
+export declare const WRITE_DOORS: readonly ['browser', 'agent', 'client'];
+export type WriteDoor = (typeof WRITE_DOORS)[number];
+export type Actor = {
+    readonly user?: string;
+    readonly site?: string;
+    readonly door?: WriteDoor;
+};
+export type DocumentEvent = {
+    readonly before: DocumentFacts | null;
+    readonly after: DocumentFacts | null;
+    readonly changed: readonly string[];
+    readonly by: Actor;
+};
+export type ItemFacts = {
+    readonly delivery: string;
+    readonly source: string | null;
+    readonly address: string | null;
+    readonly has_attachment: boolean;
+    readonly provider: string | null;
+    readonly container: string | null;
+    readonly author: string | null;
+    readonly headers: Readonly<Record<string, string>>;
+    readonly json: {
+        readonly value: unknown;
+    } | null;
+};
+export type Resolved = {
+    readonly id: string;
+    readonly member?: string;
+};
+type Truth = boolean | undefined;
+export declare function factKind(facts: ValueFacts): FactKind | null;
+export declare function facts(document: Document, at: {
+    readonly id: string;
+    readonly path: string;
+}, model: VerifiedModel, resolve: (target: string) => Resolved | undefined): DocumentFacts;
+export declare function prosePaths(facts: DocumentFacts): string[];
+export declare function dated(value: unknown): value is string;
+export declare function instant(value: unknown): bigint | undefined;
+export declare function pointed(value: unknown, pointer: string): unknown;
+export declare function holds(test: ConditionTest, document: DocumentFacts, owner: string): Truth;
+export declare function fires(condition: DocumentCondition, event: DocumentEvent, owner: string): boolean;
+export declare function itemFires(condition: ItemCondition, item: ItemFacts, owner: string): boolean;
+export {};
+//# sourceMappingURL=condition.d.ts.map

package/dist/condition.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"condition.d.ts","sourceRoot":"","sources":["../src/condition.ts"],"names":[],"mappings":"AAAA,OAAO,EAOL,KAAK,UAAU,EAChB,MAAM,iBAAiB,CAAC;AAEzB,OAAO,KAAK,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAG1D,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG;IAAE,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAA;CAAE,CAAC;AAElF,MAAM,MAAM,aAAa,GACrB;IAAE,QAAQ,CAAC,GAAG,EAAE,SAAS,aAAa,EAAE,CAAA;CAAE,GAC1C;IAAE,QAAQ,CAAC,GAAG,EAAE,SAAS,aAAa,EAAE,CAAA;CAAE,GAC1C;IAAE,QAAQ,CAAC,GAAG,EAAE,aAAa,CAAA;CAAE,GAC/B,CAAC;IAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAAG,CACzB;IAAE,QAAQ,CAAC,EAAE,EAAE,cAAc,CAAA;CAAE,GAC/B;IAAE,QAAQ,CAAC,EAAE,EAAE,SAAS,cAAc,EAAE,CAAA;CAAE,GAC1C;IAAE,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAA;CAAE,GAC5B;IAAE,QAAQ,CAAC,QAAQ,EAAE,cAAc,CAAA;CAAE,GACrC;IAAE,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,GAChC;IAAE,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,GACjC;IAAE,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,GAChC;IAAE,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,GACjC;IAAE,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAC9B,CAAC,CAAC;AAEP,MAAM,MAAM,cAAc,GACtB;IAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GACzB;IAAE,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GAC3B;IAAE,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC;AAElC,KAAK,iBAAiB,GAAG;IACvB,QAAQ,CAAC,EAAE,EAAE,WAAW,CAAC;IACzB,QAAQ,CAAC,KAAK,EAAE,cAAc,CAAC;IAC/B,QAAQ,CAAC,EAAE,CAAC,EAAE,aAAa,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,iBAAiB,GACzB,CAAC,iBAAiB,GAAG;IACnB,QAAQ,CAAC,IAAI,EAAE,iBAAiB,CAAC;IACjC,QAAQ,CAAC,aAAa,EAAE,OAAO,CAAC;IAChC,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC;CAC/B,CAAC,GACF,CAAC,iBAAiB,GAAG;IACnB,QAAQ,CAAC,IAAI,EAAE,eAAe,CAAC;IAC/B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,IAAI,CAAC,EAAE,SAAS,cAAc,EAAE,GAAG,KAAK,CAAC;IAClD,QAAQ,CAAC,EAAE,CAAC,EAAE,SAAS,cAAc,EAAE,GAAG,SAAS,CAAC;IACpD,QAAQ,CAAC,KAAK,CAAC,EAAE,aAAa,CAAC;CAChC,CAAC,CAAC;AAEP,MAAM,MAAM,aAAa,GAAG;IAC1B,QAAQ,CAAC,EAAE,EAAE,OAAO,CAAC;IACrB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,KAAK,CAAC,EAAE,aAAa,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,QAAQ,CAAC,EAAE,EAAE,OAAO,CAAC;IACrB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,QAAQ,CAAC,EAAE,EAAE,OAAO,CAAC;IACrB,QAAQ,CAAC,KAAK,EAAE;QAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IAC1C,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,KAAK,CAAC,EAAE,aAAa,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG,iBAAiB,GAAG,aAAa,GAAG,aAAa,GAAG,aAAa,CAAC;AAE1F,MAAM,MAAM,QAAQ,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,WAAW,CAAC;AAEhG,KAAK,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;AAExC,MAAM,MAAM,IAAI,GACZ;IAAE,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,GAC7E;IAAE,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAA;CAAE,GAC1B;IAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GACzB;IAAE,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAA;CAAE,GAC/B;IAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,SAAS,IAAI,EAAE,CAAA;CAAE,GAC1D;IAAE,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IAAC,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAA;CAAE,CAAC;AAEjF,MAAM,MAAM,aAAa,GAAG;IAC1B,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;IAChD,QAAQ,CAAC,QAAQ,EAAE,SAAS,MAAM,EAAE,CAAC;CACtC,CAAC;AAEF,eAAO,MAAM,WAAW,YAAI,SAAS,EAAE,OAAO,EAAE,QAAQ,CAAU,CAAC;AAEnE,MAAM,MAAM,SAAS,GAAG,CAAC,OAAO,WAAW,CAAC,CAAC,MAAM,CAAC,CAAC;AAErD,MAAM,MAAM,KAAK,GAAG;IAClB,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,IAAI,CAAC,EAAE,SAAS,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,QAAQ,CAAC,MAAM,EAAE,aAAa,GAAG,IAAI,CAAC;IACtC,QAAQ,CAAC,KAAK,EAAE,aAAa,GAAG,IAAI,CAAC;IACrC,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;IACpC,QAAQ,CAAC,EAAE,EAAE,KAAK,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG;IACtB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAC;IACjC,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IACnD,QAAQ,CAAC,IAAI,EAAE;QAAE,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;CACnD,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG;IAAE,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAEzE,KAAK,KAAK,GAAG,OAAO,GAAG,SAAS,CAAC;AAsCjC,wBAAgB,QAAQ,CAAC,KAAK,EAAE,UAAU,GAAG,QAAQ,GAAG,IAAI,CAS3D;AAgDD,wBAAgB,KAAK,CACnB,QAAQ,EAAE,QAAQ,EAClB,EAAE,EAAE;IAAE,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CAAE,EAClD,KAAK,EAAE,aAAa,EACpB,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,QAAQ,GAAG,SAAS,GAChD,aAAa,CAgBf;AAMD,wBAAgB,UAAU,CAAC,KAAK,EAAE,aAAa,GAAG,MAAM,EAAE,CAYzD;AAkHD,wBAAgB,KAAK,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAIrD;AAED,wBAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,CAgC1D;AAED,wBAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAehE;AAmJD,wBAAgB,KAAK,CAAC,IAAI,EAAE,aAAa,EAAE,QAAQ,EAAE,aAAa,EAAE,KAAK,EAAE,MAAM,GAAG,KAAK,CAExF;AAqFD,wBAAgB,KAAK,CAAC,SAAS,EAAE,iBAAiB,EAAE,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAehG;AAED,wBAAgB,SAAS,CAAC,SAAS,EAAE,aAAa,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAO3F"}