@agentshouse/mdmodel 0.1.0-c2987f5d89720 → 0.1.0-c4fe1bc82bc55
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/API.md +112 -55
- package/dist/blocks.d.ts.map +1 -1
- package/dist/blocks.js +30 -16
- package/dist/condition.d.ts +18 -6
- package/dist/condition.d.ts.map +1 -1
- package/dist/condition.js +208 -111
- package/dist/definition.d.ts +9 -0
- package/dist/definition.d.ts.map +1 -1
- package/dist/definition.js +50 -1
- package/dist/document.d.ts +4 -8
- package/dist/document.d.ts.map +1 -1
- package/dist/document.js +32 -14
- package/dist/index.d.ts +7 -5
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +4 -3
- package/dist/types.d.ts +7 -0
- package/dist/types.d.ts.map +1 -1
- package/dist/validate.d.ts.map +1 -1
- package/dist/validate.js +26 -30
- package/dist/yaml.d.ts +6 -1
- package/dist/yaml.d.ts.map +1 -1
- package/dist/yaml.js +33 -14
- package/fixtures/cases/absent-link-dangles/context.json +1 -0
- package/fixtures/cases/absent-link-dangles/expected.json +1 -0
- package/fixtures/cases/absent-link-dangles/library/item.md +8 -0
- package/fixtures/cases/absent-link-dangles/schema.yaml +6 -0
- package/fixtures/cases/absolute-link/context.json +1 -0
- package/fixtures/cases/{missing-binary-image → absolute-link}/expected.json +1 -1
- package/fixtures/cases/absolute-link/library/item.md +8 -0
- package/fixtures/cases/absolute-link/schema.yaml +6 -0
- package/fixtures/cases/binary-image-dangles/expected.json +1 -0
- package/fixtures/cases/binary-link-dangles/expected.json +1 -0
- package/fixtures/cases/quoted-link-definition/library/notes/draft.md +1 -1
- package/fixtures/cases/shortcut-reference-link/library/item.md +1 -1
- package/fixtures/cases/truncated-link-definition/library/notes/draft.md +1 -1
- package/fixtures/cases/unresolved-link/library/item.md +1 -1
- package/package.json +1 -1
- package/fixtures/cases/missing-binary-link/expected.json +0 -5
- /package/fixtures/cases/{missing-binary-image → binary-image-dangles}/context.json +0 -0
- /package/fixtures/cases/{missing-binary-image → binary-image-dangles}/library/notes/draft.md +0 -0
- /package/fixtures/cases/{missing-binary-image → binary-image-dangles}/schema.yaml +0 -0
- /package/fixtures/cases/{missing-binary-link → binary-link-dangles}/context.json +0 -0
- /package/fixtures/cases/{missing-binary-link → binary-link-dangles}/library/notes/draft.md +0 -0
- /package/fixtures/cases/{missing-binary-link → binary-link-dangles}/schema.yaml +0 -0
package/API.md
CHANGED
|
@@ -38,6 +38,9 @@ if (parsed.ok) {
|
|
|
38
38
|
}
|
|
39
39
|
```
|
|
40
40
|
|
|
41
|
+
`MARKDOWN_SYNTAX_PROFILE` is the Markdown every reader here applies, GitHub Flavored Markdown
|
|
42
|
+
0.29, and `VERSION` is the MD model version.
|
|
43
|
+
|
|
41
44
|
`verify(schema)` reads one schema text, the MD Types of one Room or App: one
|
|
42
45
|
JSON Schema document (draft 2020-12) in the YAML subset. Every top-level key but
|
|
43
46
|
`$defs` names an MD Type holding the JSON Schema of its frontmatter; `$defs`
|
|
@@ -67,16 +70,21 @@ its `frontmatter` and `fields`, its top-level ones: JSON `type`, `format`,
|
|
|
67
70
|
`values`, `reference` targets, `items`, `properties`, an open map's `patterns`
|
|
68
71
|
and `additional`, and `prose`, a string with no `enum`, `const`, `format`,
|
|
69
72
|
`pattern` or `reference`. Facts join `$ref` and `allOf` to their siblings and
|
|
70
|
-
the variants of `anyOf`, `oneOf`, `then`, `else` and `dependentSchemas
|
|
71
|
-
without one `type`, `null` aside, has
|
|
72
|
-
whole, naming its `rule`, the keyword or the
|
|
73
|
-
`location` it concerns, such as
|
|
74
|
-
outside the YAML subset.
|
|
73
|
+
the variants of `anyOf`, `oneOf`, `then`, `else` and `dependentSchemas`, a
|
|
74
|
+
variant's own keys `conditional`; a path without one `type`, `null` aside, has
|
|
75
|
+
none. A malformed schema is refused whole, naming its `rule`, the keyword or the
|
|
76
|
+
model's own, and the JSON Pointer `location` it concerns, such as
|
|
77
|
+
`/plan/properties/status/enum`, or `line <n>` outside the YAML subset.
|
|
78
|
+
`pointerFacts(definition, pointer)` reads the facts a frontmatter pointer reaches,
|
|
79
|
+
`itemFacts` and `memberFacts` take one step and `crossedFacts` reads a list's item
|
|
80
|
+
facts; `pointerSegments` and `escapePointer` split and write a pointer, `ARRAY_INDEX`
|
|
81
|
+
matches an index segment, and `ATTACHMENT` is the `reference` that admits any path.
|
|
75
82
|
|
|
76
83
|
`validate(library, context?, model?)` takes the resulting text Library and one
|
|
77
84
|
`ValidationContext` of `binaryTargets: readonly string[]`, none when omitted.
|
|
78
85
|
Library keys and binary targets share one canonical collection-relative path
|
|
79
|
-
namespace; a path declared text and binary is refused.
|
|
86
|
+
namespace; a path declared text and binary is refused. House declares every
|
|
87
|
+
binary file of the Room as a binary target, and the model reads no bytes. Ordinary links and images
|
|
80
88
|
in typed Documents may resolve to either membership, relative to the source
|
|
81
89
|
Document, and one to a path neither holds is not refused: it dangles, as a
|
|
82
90
|
deleted file's links do. A destination that is an absolute path or leaves the
|
|
@@ -102,10 +110,14 @@ and no body link is a referrer.
|
|
|
102
110
|
Validation returns acceptance or one refusal naming the file, the field or
|
|
103
111
|
section, and the violated rule. `parse`, `apply`, and `serialize` operate on a single text
|
|
104
112
|
Document; they do not validate collection membership or consume binary bytes.
|
|
105
|
-
`apply` sets one typed field, including a list
|
|
113
|
+
`apply` sets one typed field, including a list or an object as a whole, replaces
|
|
106
114
|
one existing section body or the preamble against that value's prior content,
|
|
107
115
|
or rewrites one Markdown link destination. A section need not be declared by
|
|
108
116
|
the Document's MD Type to be replaced. A field change does not reformat the rest of the file.
|
|
117
|
+
A field holds a `FrontmatterValue`: null, a string, a boolean, a finite number, a list
|
|
118
|
+
without holes or a plain object of them, holding no cycle. `frontmatterValue(value)` is that test, and
|
|
119
|
+
`apply` refuses any other value as `frontmatter-fence`; `equalValue(left, right)` compares
|
|
120
|
+
two by value, whatever their key order, as `apply` compares a field with its prior.
|
|
109
121
|
|
|
110
122
|
`Document.preamble` is a readonly string containing the exact source after
|
|
111
123
|
frontmatter and before the first section heading recognized by the existing
|
|
@@ -138,58 +150,53 @@ no newline or separator is inserted, and the resulting source is parsed again.
|
|
|
138
150
|
An invalid frontmatter result receives the existing parse refusal. Independent
|
|
139
151
|
field, section, and preamble edits keep their own prior values valid.
|
|
140
152
|
|
|
141
|
-
For a moved link, use `links` and the `link` change below to obtain the rewritten
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
`href`
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
`
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
`
|
|
172
|
-
|
|
173
|
-
path)`, keeping its `?query` or `#fragment`; `relativizeBody(body, file,
|
|
174
|
-
handle)` does so to a text without frontmatter, refusing one left under
|
|
175
|
-
`/rooms/` as `unresolved-link`.
|
|
153
|
+
For a moved link, use `links` and the `link` change below to obtain the rewritten Document, then
|
|
154
|
+
compare its public `preamble` and `sections` to the original. Submit the changed values with their
|
|
155
|
+
original priors. Consumers need no source span calculation or private Model import. Collection
|
|
156
|
+
validation remains a separate call against the resulting Library.
|
|
157
|
+
|
|
158
|
+
`links(document, file)` is the inventory of that Document's ordinary link and image destinations
|
|
159
|
+
that resolve to a collection Path, each with the destination `href` exactly as written and the
|
|
160
|
+
`target` Path it resolves to relative to `file`. A `?query` or `#fragment` the destination carries
|
|
161
|
+
is part of `href` and not part of `target`. Entries are ordered by the position of the destination
|
|
162
|
+
text a rewrite would change, and one destination written the same way appears once however many
|
|
163
|
+
times it occurs. A destination that the syntax profile does not read as a link, one that is empty,
|
|
164
|
+
a bare fragment, or carries a URL scheme, and one that leaves the collection are not in the
|
|
165
|
+
inventory. Frontmatter field values, including typed references, are not link destinations and
|
|
166
|
+
are never enumerated.
|
|
167
|
+
|
|
168
|
+
`target(file, href)` is the collection Path one written destination resolves to relative to
|
|
169
|
+
`file`, by the rule `links` and `validate` read: surrounding spaces and the `?query` or `#fragment`
|
|
170
|
+
it carries are not part of that Path. A destination that is empty, a bare fragment, carries a URL
|
|
171
|
+
scheme, starts at `/`, or leaves the collection resolves to `null`. It reads a destination written
|
|
172
|
+
anywhere, such as a typed reference field value, which `links` never enumerates.
|
|
173
|
+
`retarget(href, to)` is that destination rewritten to `to`, keeping the `?query` or `#fragment` it
|
|
174
|
+
carried, which is the destination the `link` change below writes.
|
|
175
|
+
|
|
176
|
+
`references(document, definition)` lists each frontmatter `reference` string at any depth as
|
|
177
|
+
`pointer`, `value` and `to`; `apply(document, { kind: 'reference', pointer, value, prior })`
|
|
178
|
+
rewrites one in place, keeping its quotes, or is `stale`. `relativize(document, file, handle,
|
|
179
|
+
definition?)` rewrites each link destination and reference written `/rooms/<handle>/<path>` to
|
|
180
|
+
`relative(file, path)`, keeping its `?query` or `#fragment`. A text without frontmatter, such as
|
|
181
|
+
a captured body, is read from its first character: `relativizeBody(body, file, handle)` converts
|
|
182
|
+
it so, refusing a destination left under `/rooms/` as `unresolved-link`; `bodyLinks(body, file)`
|
|
183
|
+
is its `links`; `relinkBody(body, file, moves)` writes, in one pass, each destination whose Path
|
|
184
|
+
is a key of `moves` as relative to its value, in the form the `link` change below writes.
|
|
176
185
|
|
|
177
186
|
```ts
|
|
178
187
|
target('items/six.md', ' ../projects/atlas.md#overview '); // 'projects/atlas.md'
|
|
179
188
|
retarget(' ../projects/atlas.md#overview ', '../archive/atlas.md'); // '../archive/atlas.md#overview'
|
|
180
189
|
```
|
|
181
190
|
|
|
182
|
-
`apply(document, { kind: 'link', href, to })` rewrites every body occurrence of
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
inside angle brackets, which the original form is kept in when it still fits. A
|
|
192
|
-
destination that neither form can carry is refused as `unwritable-link`.
|
|
191
|
+
`apply(document, { kind: 'link', href, to })` rewrites every body occurrence of that written
|
|
192
|
+
destination and changes nothing else, so a caller that moves a Path rewrites its referring
|
|
193
|
+
Documents without a second Markdown parser. `to` is the Path the destination must resolve to
|
|
194
|
+
instead; the `?query` or `#fragment` the written destination carried is not part of that Path and
|
|
195
|
+
is kept. A Document that does not carry the destination is `stale`. A reference definition is
|
|
196
|
+
rewritten once however many uses name it. The destination is written in the form the syntax
|
|
197
|
+
profile reads back: bare when it carries no whitespace, does not open with `<`, and balances its
|
|
198
|
+
parentheses, otherwise inside angle brackets, which the original form is kept in when it still
|
|
199
|
+
fits. A destination that neither form can carry is refused as `unwritable-link`.
|
|
193
200
|
|
|
194
201
|
`project(document, file, context?)` is the Embedding projection input of one
|
|
195
202
|
Document: the prose a consumer embeds, with every internal Markdown-document
|
|
@@ -221,7 +228,7 @@ Document's `type` names, taken from the model `verify` returned. A Document that
|
|
|
221
228
|
declares a type the caller supplies no definition for is refused as
|
|
222
229
|
`unknown-type`. `documentTargets` is what makes a destination internal: a
|
|
223
230
|
destination resolving to a supplied Path is internal, and every other
|
|
224
|
-
destination stays authored text, a
|
|
231
|
+
destination stays authored text, a binary target and a Path nobody
|
|
225
232
|
supplied alike. The caller supplies that membership, as it does for `validate`;
|
|
226
233
|
the model reads no bytes, resolves no authority, and classifies nothing it was
|
|
227
234
|
not given.
|
|
@@ -231,7 +238,7 @@ title, in the inline `[label](path)`, full `[label][id]`, collapsed
|
|
|
231
238
|
`[label][]`, and shortcut `[label]` forms, and the link reference definition an
|
|
232
239
|
enumerated use resolves through leaves the projection with it. An image at a
|
|
233
240
|
supplied document target contributes its alt text the same way, because a move
|
|
234
|
-
rewrites that destination too. External URLs,
|
|
241
|
+
rewrites that destination too. External URLs, binary targets,
|
|
235
242
|
unsupplied destinations, bare fragments, code spans, fenced code, and escaped
|
|
236
243
|
syntax stay exactly as authored, read through the same syntax profile `links`
|
|
237
244
|
and `validate` read. `project` returns text and never rewrites the Document.
|
|
@@ -300,3 +307,53 @@ author quoted. A Span divided out of one free-text field value addresses that
|
|
|
300
307
|
whole value, because a YAML scalar's own positions are the only ones its source
|
|
301
308
|
has, and a Span carrying part of one internal link's label addresses that whole
|
|
302
309
|
link, because a cut never falls inside link syntax.
|
|
310
|
+
|
|
311
|
+
## Conditions
|
|
312
|
+
|
|
313
|
+
`facts(document, { id, path }, model, resolve)` reads one Document as the `DocumentFacts` a
|
|
314
|
+
condition tests: its `id`, its `path` with a leading `/`, its `type` or `null`, its `sections`, and
|
|
315
|
+
a `Fact` for each frontmatter field it writes that its MD Type declares. `factKind(facts)` names
|
|
316
|
+
the kind a declared value compares as: `reference`, `enum`, `number`, `boolean`, `date`, `time`
|
|
317
|
+
(a `date-time`) or `string`, else `null`. A prose value, or one of no kind, is `prose`, a list or
|
|
318
|
+
an object holds the facts of its members, and a value written `null` is `null`. A value that does
|
|
319
|
+
not fit its kind, such as a string in a number field, a value outside its `enum` or a reference
|
|
320
|
+
`resolve` maps to no `{ id, member? }`, is `unreadable`; a readable reference compares as that `id`.
|
|
321
|
+
|
|
322
|
+
`holds(test, facts, owner)` is `true`, `false` or `undefined`, unknown; a Trigger fires on `true`
|
|
323
|
+
alone. A test's `path` is `/path`, `/type`, `/sections/<heading>`, `/fields/<pointer>`, or
|
|
324
|
+
`/members/<pointer>`, the member of the Document a reference field reaches. A pointer segment that
|
|
325
|
+
is not an index reads every item of a list, an item lacking it unknown, and a test over several
|
|
326
|
+
values holds as `any` does. The value `{ owner: true }` stands for `owner`, a User id.
|
|
327
|
+
|
|
328
|
+
| The path reaches | `exists` | `contains` | any other test |
|
|
329
|
+
| --------------------------------------- | ----------- | -------------- | -------------- |
|
|
330
|
+
| a value | present | `undefined` | compared |
|
|
331
|
+
| `null`, prose or a section | present | `undefined` | `undefined` |
|
|
332
|
+
| a list | present | `any` of items | `undefined` |
|
|
333
|
+
| no item, through an empty list | absent | `false` | `false` |
|
|
334
|
+
| nothing: no such field, section or type | absent | `undefined` | `undefined` |
|
|
335
|
+
| only unreadable values | `undefined` | `undefined` | `undefined` |
|
|
336
|
+
|
|
337
|
+
`exists: true` holds where present and fails where absent, `exists: false` the reverse. `all` is
|
|
338
|
+
`false` if a part is, else `undefined` if a part is; `any` is `true` if a part is, else `undefined`
|
|
339
|
+
if a part is; `not` keeps `undefined`, so absence is tested with `exists`, never with `not`. `eq`
|
|
340
|
+
and `in` are `undefined` against a value of another JSON type and compare a `time` as an instant;
|
|
341
|
+
`prefix` reads only a string, never a reference or a member; `gt`, `gte`, `lt` and `lte` order
|
|
342
|
+
numbers, dates and times alone.
|
|
343
|
+
|
|
344
|
+
`fires(condition, event, owner)` reads one change, `{ before, after, changed, by }`: the facts of
|
|
345
|
+
each side, `null` on the side a creation or a deletion lacks, the `changed` paths whose prose
|
|
346
|
+
changed, and the actor whose `/user`, `/site` and `/door`, one of `WRITE_DOORS`, a `by` test reads.
|
|
347
|
+
`starts_matching` fires when the Document is in `scope` and holds `match` after the change and did
|
|
348
|
+
not before; a creation fires only with `new_documents: true`, and a deletion never fires.
|
|
349
|
+
`field_changes` fires when the side the Document has, after or for a deletion before, is in `scope`
|
|
350
|
+
and holds `match`, and `field` changed: its facts differ, or with neither `from` nor `to` `changed`
|
|
351
|
+
names it. A field absent on both sides never fires; `from: 'new'` admits only a creation and
|
|
352
|
+
`to: 'deleted'` only a deletion, and listed values need that side to hold `field` `in` them.
|
|
353
|
+
|
|
354
|
+
`itemFires(condition, item, owner)` compares `source` and `address` where given and holds `match`
|
|
355
|
+
over `/delivery`, `/source`, `/provider`, `/container`, `/author`, `/has_attachment`,
|
|
356
|
+
`/headers/<name>` and `/json/<pointer>`, unknown for an item with no JSON. `prosePaths(facts)` lists
|
|
357
|
+
the prose and section paths whose text builds `changed`; `pointed(value, pointer)` reads a JSON
|
|
358
|
+
Pointer, `undefined` where nothing is; `dated(value)` checks a `YYYY-MM-DD` date, and
|
|
359
|
+
`instant(value)` reads an RFC 3339 time with its offset as epoch nanoseconds, a `bigint`.
|
package/dist/blocks.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"blocks.d.ts","sourceRoot":"","sources":["../src/blocks.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAEzC,MAAM,MAAM,WAAW,GAAG;IACxB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB,CAAC;
|
|
1
|
+
{"version":3,"file":"blocks.d.ts","sourceRoot":"","sources":["../src/blocks.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAEzC,MAAM,MAAM,WAAW,GAAG;IACxB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB,CAAC;AAqCF,wBAAgB,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,WAAW,EAAE,CA+BrF;AAED,wBAAgB,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,CAe/E"}
|
package/dist/blocks.js
CHANGED
|
@@ -23,24 +23,38 @@ function scan(content, from, to, visit) {
|
|
|
23
23
|
i = next;
|
|
24
24
|
}
|
|
25
25
|
}
|
|
26
|
+
const HASH = 0x23;
|
|
26
27
|
export function headingLines(content, from, to) {
|
|
27
28
|
const found = [];
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
const
|
|
32
|
-
const
|
|
33
|
-
const
|
|
34
|
-
if (
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
29
|
+
let fences = null;
|
|
30
|
+
let i = from;
|
|
31
|
+
while (i < to) {
|
|
32
|
+
const nl = content.indexOf('\n', i);
|
|
33
|
+
const end = nl === -1 || nl >= to ? to : nl;
|
|
34
|
+
const next = end === to ? to : end + 1;
|
|
35
|
+
if (content.charCodeAt(i) === HASH) {
|
|
36
|
+
fences ??= fenceSpans(content.slice(from, to));
|
|
37
|
+
const at = i - from;
|
|
38
|
+
if (!fences.some(([start, stop]) => at >= start && at < stop)) {
|
|
39
|
+
const { text } = lineAt(content, i, to);
|
|
40
|
+
const match = HEADING.exec(text);
|
|
41
|
+
const hashes = match?.[1];
|
|
42
|
+
const name = match?.[2];
|
|
43
|
+
if (hashes !== undefined && name !== undefined) {
|
|
44
|
+
found.push({
|
|
45
|
+
level: hashes.length,
|
|
46
|
+
name: name.trim(),
|
|
47
|
+
start: i,
|
|
48
|
+
textEnd: i + text.length,
|
|
49
|
+
next,
|
|
50
|
+
});
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
if (next === i)
|
|
55
|
+
break;
|
|
56
|
+
i = next;
|
|
57
|
+
}
|
|
44
58
|
return found;
|
|
45
59
|
}
|
|
46
60
|
export function blockRanges(content, from, to) {
|
package/dist/condition.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type
|
|
1
|
+
import { type ValueFacts } from './definition.js';
|
|
2
2
|
import type { Document, VerifiedModel } from './types.js';
|
|
3
3
|
export type ConditionValue = string | number | boolean | {
|
|
4
4
|
readonly owner: true;
|
|
@@ -77,18 +77,30 @@ export type DateCondition = {
|
|
|
77
77
|
};
|
|
78
78
|
export type Condition = DocumentCondition | ItemCondition | CronCondition | DateCondition;
|
|
79
79
|
export type FactKind = 'string' | 'number' | 'boolean' | 'date' | 'time' | 'enum' | 'reference';
|
|
80
|
+
type Scalar = string | number | boolean;
|
|
80
81
|
export type Fact = {
|
|
81
82
|
readonly kind: FactKind;
|
|
82
|
-
readonly value: Scalar
|
|
83
|
+
readonly value: Scalar;
|
|
84
|
+
readonly member?: string;
|
|
85
|
+
} | {
|
|
86
|
+
readonly kind: 'prose';
|
|
87
|
+
} | {
|
|
88
|
+
readonly kind: 'null';
|
|
89
|
+
} | {
|
|
90
|
+
readonly kind: 'unreadable';
|
|
91
|
+
} | {
|
|
92
|
+
readonly kind: 'list';
|
|
93
|
+
readonly items: readonly Fact[];
|
|
94
|
+
} | {
|
|
95
|
+
readonly kind: 'object';
|
|
96
|
+
readonly fields: Readonly<Record<string, Fact>>;
|
|
83
97
|
};
|
|
84
98
|
export type DocumentFacts = {
|
|
85
99
|
readonly id: string;
|
|
86
100
|
readonly path: string;
|
|
87
101
|
readonly type: string | null;
|
|
88
102
|
readonly fields: Readonly<Record<string, Fact>>;
|
|
89
|
-
readonly
|
|
90
|
-
readonly prose: readonly string[];
|
|
91
|
-
readonly unreadable: readonly string[];
|
|
103
|
+
readonly sections: readonly string[];
|
|
92
104
|
};
|
|
93
105
|
export declare const WRITE_DOORS: readonly ['browser', 'agent', 'client'];
|
|
94
106
|
export type WriteDoor = (typeof WRITE_DOORS)[number];
|
|
@@ -121,12 +133,12 @@ export type Resolved = {
|
|
|
121
133
|
readonly member?: string;
|
|
122
134
|
};
|
|
123
135
|
type Truth = boolean | undefined;
|
|
124
|
-
type Scalar = string | number | boolean;
|
|
125
136
|
export declare function factKind(facts: ValueFacts): FactKind | null;
|
|
126
137
|
export declare function facts(document: Document, at: {
|
|
127
138
|
readonly id: string;
|
|
128
139
|
readonly path: string;
|
|
129
140
|
}, model: VerifiedModel, resolve: (target: string) => Resolved | undefined): DocumentFacts;
|
|
141
|
+
export declare function prosePaths(facts: DocumentFacts): string[];
|
|
130
142
|
export declare function dated(value: unknown): value is string;
|
|
131
143
|
export declare function instant(value: unknown): bigint | undefined;
|
|
132
144
|
export declare function pointed(value: unknown, pointer: string): unknown;
|
package/dist/condition.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"condition.d.ts","sourceRoot":"","sources":["../src/condition.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,
|
|
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;AA4GD,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"}
|