@x12i/made-easy 0.0.0-stage → 0.1.0
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/LICENSE +21 -0
- package/README.md +57 -2
- package/dist/analysis.d.ts +19 -0
- package/dist/analysis.d.ts.map +1 -0
- package/dist/analysis.js +90 -0
- package/dist/analysis.js.map +1 -0
- package/dist/build.d.ts +36 -0
- package/dist/build.d.ts.map +1 -0
- package/dist/build.js +260 -0
- package/dist/build.js.map +1 -0
- package/dist/contracts/api.d.ts +447 -0
- package/dist/contracts/api.d.ts.map +1 -0
- package/dist/contracts/api.js +152 -0
- package/dist/contracts/api.js.map +1 -0
- package/dist/contracts/blocks.d.ts +221 -0
- package/dist/contracts/blocks.d.ts.map +1 -0
- package/dist/contracts/blocks.js +392 -0
- package/dist/contracts/blocks.js.map +1 -0
- package/dist/contracts/diagnostics.d.ts +111 -0
- package/dist/contracts/diagnostics.d.ts.map +1 -0
- package/dist/contracts/diagnostics.js +122 -0
- package/dist/contracts/diagnostics.js.map +1 -0
- package/dist/contracts/index.d.ts +11 -0
- package/dist/contracts/index.d.ts.map +1 -0
- package/dist/contracts/index.js +11 -0
- package/dist/contracts/index.js.map +1 -0
- package/dist/contracts/json-schema.d.ts +5 -0
- package/dist/contracts/json-schema.d.ts.map +1 -0
- package/dist/contracts/json-schema.js +41 -0
- package/dist/contracts/json-schema.js.map +1 -0
- package/dist/contracts/recipe.d.ts +535 -0
- package/dist/contracts/recipe.d.ts.map +1 -0
- package/dist/contracts/recipe.js +380 -0
- package/dist/contracts/recipe.js.map +1 -0
- package/dist/contracts/schemas.d.ts +413 -0
- package/dist/contracts/schemas.d.ts.map +1 -0
- package/dist/contracts/schemas.js +205 -0
- package/dist/contracts/schemas.js.map +1 -0
- package/dist/draft.d.ts +157 -0
- package/dist/draft.d.ts.map +1 -0
- package/dist/draft.js +254 -0
- package/dist/draft.js.map +1 -0
- package/dist/emit-assets.d.ts +2 -0
- package/dist/emit-assets.d.ts.map +1 -0
- package/dist/emit-assets.js +27 -0
- package/dist/emit-assets.js.map +1 -0
- package/dist/index.d.ts +25 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +30 -0
- package/dist/index.js.map +1 -0
- package/dist/markdown-doc.d.ts +59 -0
- package/dist/markdown-doc.d.ts.map +1 -0
- package/dist/markdown-doc.js +187 -0
- package/dist/markdown-doc.js.map +1 -0
- package/dist/model.d.ts +54 -0
- package/dist/model.d.ts.map +1 -0
- package/dist/model.js +244 -0
- package/dist/model.js.map +1 -0
- package/dist/normalize.d.ts +63 -0
- package/dist/normalize.d.ts.map +1 -0
- package/dist/normalize.js +54 -0
- package/dist/normalize.js.map +1 -0
- package/dist/npm.d.ts +24 -0
- package/dist/npm.d.ts.map +1 -0
- package/dist/npm.js +51 -0
- package/dist/npm.js.map +1 -0
- package/dist/render/blocks.d.ts +17 -0
- package/dist/render/blocks.d.ts.map +1 -0
- package/dist/render/blocks.js +384 -0
- package/dist/render/blocks.js.map +1 -0
- package/dist/render/brief.d.ts +77 -0
- package/dist/render/brief.d.ts.map +1 -0
- package/dist/render/brief.js +62 -0
- package/dist/render/brief.js.map +1 -0
- package/dist/render/context.d.ts +43 -0
- package/dist/render/context.d.ts.map +1 -0
- package/dist/render/context.js +88 -0
- package/dist/render/context.js.map +1 -0
- package/dist/render/html.d.ts +19 -0
- package/dist/render/html.d.ts.map +1 -0
- package/dist/render/html.js +178 -0
- package/dist/render/html.js.map +1 -0
- package/dist/render/markdown-out.d.ts +11 -0
- package/dist/render/markdown-out.d.ts.map +1 -0
- package/dist/render/markdown-out.js +121 -0
- package/dist/render/markdown-out.js.map +1 -0
- package/dist/render/pdf.d.ts +23 -0
- package/dist/render/pdf.d.ts.map +1 -0
- package/dist/render/pdf.js +138 -0
- package/dist/render/pdf.js.map +1 -0
- package/dist/render/prose.d.ts +15 -0
- package/dist/render/prose.d.ts.map +1 -0
- package/dist/render/prose.js +110 -0
- package/dist/render/prose.js.map +1 -0
- package/dist/scaffold.d.ts +13 -0
- package/dist/scaffold.d.ts.map +1 -0
- package/dist/scaffold.js +393 -0
- package/dist/scaffold.js.map +1 -0
- package/dist/sdk.d.ts +56 -0
- package/dist/sdk.d.ts.map +1 -0
- package/dist/sdk.js +238 -0
- package/dist/sdk.js.map +1 -0
- package/dist/source.d.ts +57 -0
- package/dist/source.d.ts.map +1 -0
- package/dist/source.js +289 -0
- package/dist/source.js.map +1 -0
- package/dist/theme/book.d.ts +10 -0
- package/dist/theme/book.d.ts.map +1 -0
- package/dist/theme/book.js +198 -0
- package/dist/theme/book.js.map +1 -0
- package/dist/util.d.ts +14 -0
- package/dist/util.d.ts.map +1 -0
- package/dist/util.js +69 -0
- package/dist/util.js.map +1 -0
- package/dist/validate.d.ts +36 -0
- package/dist/validate.d.ts.map +1 -0
- package/dist/validate.js +986 -0
- package/dist/validate.js.map +1 -0
- package/dist/verify.d.ts +35 -0
- package/dist/verify.d.ts.map +1 -0
- package/dist/verify.js +112 -0
- package/dist/verify.js.map +1 -0
- package/dist/version.d.ts +3 -0
- package/dist/version.d.ts.map +1 -0
- package/dist/version.js +4 -0
- package/dist/version.js.map +1 -0
- package/dist/yamlfile.d.ts +22 -0
- package/dist/yamlfile.d.ts.map +1 -0
- package/dist/yamlfile.js +129 -0
- package/dist/yamlfile.js.map +1 -0
- package/package.json +64 -4
- package/recipes/index.json +282 -0
- package/recipes/shared-1.0.0.json +456 -0
- package/schemas/artifact.v1.json +36 -0
- package/schemas/assets.v1.json +61 -0
- package/schemas/block.v1.json +27 -0
- package/schemas/blocks/brief.v1.json +20 -0
- package/schemas/blocks/callout.v1.json +25 -0
- package/schemas/blocks/code.v1.json +21 -0
- package/schemas/blocks/decision.v1.json +80 -0
- package/schemas/blocks/evidence-comparison.v1.json +33 -0
- package/schemas/blocks/example.v1.json +52 -0
- package/schemas/blocks/figure.v1.json +22 -0
- package/schemas/blocks/human-action.v1.json +42 -0
- package/schemas/blocks/job-map.v1.json +170 -0
- package/schemas/blocks/pause.v1.json +25 -0
- package/schemas/blocks/reference-profile.v1.json +41 -0
- package/schemas/blocks/review-checklist.v1.json +19 -0
- package/schemas/blocks/table.v1.json +59 -0
- package/schemas/brief.v1.json +157 -0
- package/schemas/build-request.v1.json +173 -0
- package/schemas/build-result.v1.json +171 -0
- package/schemas/checks.v1.json +149 -0
- package/schemas/create-request.v1.json +47 -0
- package/schemas/diagnostic.v1.json +50 -0
- package/schemas/draft-request.v1.json +196 -0
- package/schemas/guide.v1.json +172 -0
- package/schemas/job.v1.json +107 -0
- package/schemas/preview-request.v1.json +153 -0
- package/schemas/preview-result.v1.json +84 -0
- package/schemas/problem.v1.json +78 -0
- package/schemas/recipe-definition.v1.json +673 -0
- package/schemas/source-ref.v1.json +111 -0
- package/schemas/sources.v1.json +158 -0
- package/schemas/validate-request.v1.json +135 -0
- package/schemas/validate-result.v1.json +110 -0
- package/schemas/verification.v1.json +77 -0
- package/themes/book/1.0.0/theme.css +190 -0
- package/themes/book/1.0.0/theme.json +5 -0
|
@@ -0,0 +1,187 @@
|
|
|
1
|
+
import { BlockEnvelopeSchema, REF_KINDS } from './contracts/index.js';
|
|
2
|
+
import { normalizeText, slugify } from './util.js';
|
|
3
|
+
import { parseYaml, pointerFromPath } from './yamlfile.js';
|
|
4
|
+
const OPEN_FENCE = /^( {0,3})(`{3,}|~{3,})[ \t]*([^`]*)$/;
|
|
5
|
+
const HEADING = /^(#{1,6})[ \t]+(.*?)(?:[ \t]+\{#([A-Za-z0-9][A-Za-z0-9_-]*)\})?[ \t]*$/;
|
|
6
|
+
export const REF_PATTERN = new RegExp(`\\[\\[(${REF_KINDS.join('|')}):([a-z0-9][a-z0-9_-]*)(#[A-Za-z0-9_-]+)?\\]\\]`, 'g');
|
|
7
|
+
export const PLACEHOLDER_PATTERN = /\[\[TODO:[^\]]*\]\]/g;
|
|
8
|
+
/** Split a markdown file into prose and `made-easy` structured blocks, collecting headings. */
|
|
9
|
+
export function parseMarkdownDoc(path, rawText) {
|
|
10
|
+
const text = normalizeText(rawText).replace(/\n$/, '');
|
|
11
|
+
const lines = text.split('\n');
|
|
12
|
+
const nodes = [];
|
|
13
|
+
const headings = [];
|
|
14
|
+
const diagnostics = [];
|
|
15
|
+
const usedAnchors = new Set();
|
|
16
|
+
let buffer = [];
|
|
17
|
+
let bufferStart = 1;
|
|
18
|
+
const flush = (endLine) => {
|
|
19
|
+
if (buffer.some((l) => l.trim() !== '')) {
|
|
20
|
+
nodes.push({ kind: 'markdown', source: buffer.join('\n'), line: bufferStart, endLine });
|
|
21
|
+
}
|
|
22
|
+
buffer = [];
|
|
23
|
+
};
|
|
24
|
+
let i = 0;
|
|
25
|
+
while (i < lines.length) {
|
|
26
|
+
const line = lines[i];
|
|
27
|
+
const open = OPEN_FENCE.exec(line);
|
|
28
|
+
if (open) {
|
|
29
|
+
const fence = open[2];
|
|
30
|
+
const info = (open[3] ?? '').trim();
|
|
31
|
+
// find closing fence
|
|
32
|
+
let j = i + 1;
|
|
33
|
+
while (j < lines.length) {
|
|
34
|
+
const l = lines[j].trimEnd();
|
|
35
|
+
const m = /^ {0,3}(`{3,}|~{3,})$/.exec(l);
|
|
36
|
+
if (m && m[1][0] === fence[0] && m[1].length >= fence.length)
|
|
37
|
+
break;
|
|
38
|
+
j++;
|
|
39
|
+
}
|
|
40
|
+
const closed = j < lines.length;
|
|
41
|
+
if (/^made-easy(\s|$)/.test(info)) {
|
|
42
|
+
flush(i);
|
|
43
|
+
const bodyLines = lines.slice(i + 1, closed ? j : lines.length);
|
|
44
|
+
if (!closed) {
|
|
45
|
+
diagnostics.push({
|
|
46
|
+
code: 'BLOCK_PARSE_ERROR',
|
|
47
|
+
severity: 'error',
|
|
48
|
+
path,
|
|
49
|
+
line: i + 1,
|
|
50
|
+
message: 'The structured block is not closed with a matching fence.',
|
|
51
|
+
});
|
|
52
|
+
}
|
|
53
|
+
const parsed = parseYaml(path, bodyLines.join('\n'), i + 1);
|
|
54
|
+
diagnostics.push(...parsed.diagnostics);
|
|
55
|
+
if (!parsed.diagnostics.length) {
|
|
56
|
+
const env = BlockEnvelopeSchema.safeParse(parsed.data);
|
|
57
|
+
if (env.success) {
|
|
58
|
+
nodes.push({
|
|
59
|
+
kind: 'block',
|
|
60
|
+
id: env.data.id,
|
|
61
|
+
type: env.data.type,
|
|
62
|
+
props: (env.data.props ?? {}),
|
|
63
|
+
line: i + 1,
|
|
64
|
+
endLine: closed ? j + 1 : lines.length,
|
|
65
|
+
lineOf: parsed.lineOf,
|
|
66
|
+
});
|
|
67
|
+
}
|
|
68
|
+
else {
|
|
69
|
+
for (const issue of env.error.issues) {
|
|
70
|
+
if (issue.code === 'unrecognized_keys') {
|
|
71
|
+
for (const k of issue.keys) {
|
|
72
|
+
diagnostics.push({
|
|
73
|
+
code: 'BLOCK_PARSE_ERROR',
|
|
74
|
+
severity: 'error',
|
|
75
|
+
path,
|
|
76
|
+
line: parsed.lineOf(pointerFromPath([k])),
|
|
77
|
+
message: `Unknown block field "${k}". Blocks have id, type and props.`,
|
|
78
|
+
});
|
|
79
|
+
}
|
|
80
|
+
continue;
|
|
81
|
+
}
|
|
82
|
+
diagnostics.push({
|
|
83
|
+
code: 'BLOCK_PARSE_ERROR',
|
|
84
|
+
severity: 'error',
|
|
85
|
+
path,
|
|
86
|
+
line: parsed.lineOf(pointerFromPath(issue.path)),
|
|
87
|
+
message: `${issue.path.join('.') || 'block'}: ${issue.message}`,
|
|
88
|
+
});
|
|
89
|
+
}
|
|
90
|
+
}
|
|
91
|
+
}
|
|
92
|
+
bufferStart = (closed ? j : lines.length) + 2;
|
|
93
|
+
i = closed ? j + 1 : lines.length;
|
|
94
|
+
continue;
|
|
95
|
+
}
|
|
96
|
+
// Ordinary code fence: keep as prose, never scan inside.
|
|
97
|
+
if (!buffer.length)
|
|
98
|
+
bufferStart = i + 1;
|
|
99
|
+
const end = closed ? j : lines.length - 1;
|
|
100
|
+
for (let k = i; k <= end; k++)
|
|
101
|
+
buffer.push(lines[k]);
|
|
102
|
+
i = end + 1;
|
|
103
|
+
continue;
|
|
104
|
+
}
|
|
105
|
+
const h = HEADING.exec(line);
|
|
106
|
+
if (h) {
|
|
107
|
+
const level = h[1].length;
|
|
108
|
+
const textRaw = h[2].replace(/[ \t]+#+[ \t]*$/, '').trim();
|
|
109
|
+
const explicit = h[3];
|
|
110
|
+
let anchor = explicit ?? slugify(textRaw.replace(/[`*_]/g, ''));
|
|
111
|
+
if (!explicit) {
|
|
112
|
+
let n = 2;
|
|
113
|
+
const base = anchor;
|
|
114
|
+
while (usedAnchors.has(anchor))
|
|
115
|
+
anchor = `${base}-${n++}`;
|
|
116
|
+
}
|
|
117
|
+
usedAnchors.add(anchor);
|
|
118
|
+
headings.push({ level, text: textRaw, anchor, explicit: Boolean(explicit), line: i + 1 });
|
|
119
|
+
}
|
|
120
|
+
if (!buffer.length)
|
|
121
|
+
bufferStart = i + 1;
|
|
122
|
+
buffer.push(line);
|
|
123
|
+
i++;
|
|
124
|
+
}
|
|
125
|
+
flush(lines.length);
|
|
126
|
+
return { nodes, headings, diagnostics };
|
|
127
|
+
}
|
|
128
|
+
/** Strip inline code spans so references and placeholders inside them are ignored. */
|
|
129
|
+
function maskInlineCode(line) {
|
|
130
|
+
return line.replace(/(`+)([^`]|[^`][\s\S]*?[^`])\1(?!`)/g, (m) => ' '.repeat(m.length));
|
|
131
|
+
}
|
|
132
|
+
/** Iterate prose lines of a markdown node, skipping fenced code. */
|
|
133
|
+
export function* proseLines(node) {
|
|
134
|
+
const lines = node.source.split('\n');
|
|
135
|
+
let fence;
|
|
136
|
+
for (let k = 0; k < lines.length; k++) {
|
|
137
|
+
const l = lines[k];
|
|
138
|
+
const m = /^ {0,3}(`{3,}|~{3,})/.exec(l);
|
|
139
|
+
if (m) {
|
|
140
|
+
if (!fence)
|
|
141
|
+
fence = m[1][0].repeat(m[1].length);
|
|
142
|
+
else if (m[1][0] === fence[0] && m[1].length >= fence.length && l.trim() === m[1])
|
|
143
|
+
fence = undefined;
|
|
144
|
+
continue;
|
|
145
|
+
}
|
|
146
|
+
if (fence)
|
|
147
|
+
continue;
|
|
148
|
+
yield { text: maskInlineCode(l), line: node.line + k };
|
|
149
|
+
}
|
|
150
|
+
}
|
|
151
|
+
export function extractInlineRefs(node) {
|
|
152
|
+
const out = [];
|
|
153
|
+
for (const { text, line } of proseLines(node)) {
|
|
154
|
+
for (const m of text.matchAll(REF_PATTERN)) {
|
|
155
|
+
out.push({
|
|
156
|
+
kind: m[1],
|
|
157
|
+
id: m[2],
|
|
158
|
+
anchor: m[3]?.slice(1),
|
|
159
|
+
line,
|
|
160
|
+
raw: m[0],
|
|
161
|
+
});
|
|
162
|
+
}
|
|
163
|
+
}
|
|
164
|
+
return out;
|
|
165
|
+
}
|
|
166
|
+
/** Bundle paths of Markdown images (``), normalised the way the renderer looks them up. */
|
|
167
|
+
export function extractImagePaths(node) {
|
|
168
|
+
const out = [];
|
|
169
|
+
for (const { text } of proseLines(node)) {
|
|
170
|
+
for (const m of text.matchAll(/!\[[^\]]*\]\(\s*<?([^)\s>]+)/g))
|
|
171
|
+
out.push(m[1].replace(/^\.\//, ''));
|
|
172
|
+
}
|
|
173
|
+
return out;
|
|
174
|
+
}
|
|
175
|
+
export function extractPlaceholders(node) {
|
|
176
|
+
const out = [];
|
|
177
|
+
for (const { text, line } of proseLines(node)) {
|
|
178
|
+
for (const m of text.matchAll(PLACEHOLDER_PATTERN))
|
|
179
|
+
out.push({ line, text: m[0] });
|
|
180
|
+
}
|
|
181
|
+
return out;
|
|
182
|
+
}
|
|
183
|
+
/** Prose text without fenced code, markup noise or placeholders, for word counting. */
|
|
184
|
+
export function proseText(node) {
|
|
185
|
+
return [...proseLines(node)].map((l) => l.text).join('\n');
|
|
186
|
+
}
|
|
187
|
+
//# sourceMappingURL=markdown-doc.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"markdown-doc.js","sourceRoot":"","sources":["../src/markdown-doc.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAE,SAAS,EAAgB,MAAM,sBAAsB,CAAC;AACpF,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACnD,OAAO,EAAE,SAAS,EAAE,eAAe,EAAmB,MAAM,eAAe,CAAC;AAqC5E,MAAM,UAAU,GAAG,sCAAsC,CAAC;AAC1D,MAAM,OAAO,GAAG,wEAAwE,CAAC;AAEzF,MAAM,CAAC,MAAM,WAAW,GAAG,IAAI,MAAM,CACnC,UAAU,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,iDAAiD,EAC9E,GAAG,CACJ,CAAC;AACF,MAAM,CAAC,MAAM,mBAAmB,GAAG,sBAAsB,CAAC;AAE1D,+FAA+F;AAC/F,MAAM,UAAU,gBAAgB,CAAC,IAAY,EAAE,OAAe;IAC5D,MAAM,IAAI,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IACvD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC/B,MAAM,KAAK,GAAc,EAAE,CAAC;IAC5B,MAAM,QAAQ,GAAc,EAAE,CAAC;IAC/B,MAAM,WAAW,GAAiB,EAAE,CAAC;IACrC,MAAM,WAAW,GAAG,IAAI,GAAG,EAAU,CAAC;IAEtC,IAAI,MAAM,GAAa,EAAE,CAAC;IAC1B,IAAI,WAAW,GAAG,CAAC,CAAC;IACpB,MAAM,KAAK,GAAG,CAAC,OAAe,EAAE,EAAE;QAChC,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;YACxC,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,CAAC;QAC1F,CAAC;QACD,MAAM,GAAG,EAAE,CAAC;IACd,CAAC,CAAC;IAEF,IAAI,CAAC,GAAG,CAAC,CAAC;IACV,OAAO,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;QACxB,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAE,CAAC;QACvB,MAAM,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnC,IAAI,IAAI,EAAE,CAAC;YACT,MAAM,KAAK,GAAG,IAAI,CAAC,CAAC,CAAE,CAAC;YACvB,MAAM,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;YACpC,qBAAqB;YACrB,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACd,OAAO,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;gBACxB,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAE,CAAC,OAAO,EAAE,CAAC;gBAC9B,MAAM,CAAC,GAAG,uBAAuB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;gBAC1C,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAE,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAE,CAAC,MAAM,IAAI,KAAK,CAAC,MAAM;oBAAE,MAAM;gBACtE,CAAC,EAAE,CAAC;YACN,CAAC;YACD,MAAM,MAAM,GAAG,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC;YAChC,IAAI,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;gBAClC,KAAK,CAAC,CAAC,CAAC,CAAC;gBACT,MAAM,SAAS,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;gBAChE,IAAI,CAAC,MAAM,EAAE,CAAC;oBACZ,WAAW,CAAC,IAAI,CAAC;wBACf,IAAI,EAAE,mBAAmB;wBACzB,QAAQ,EAAE,OAAO;wBACjB,IAAI;wBACJ,IAAI,EAAE,CAAC,GAAG,CAAC;wBACX,OAAO,EAAE,2DAA2D;qBACrE,CAAC,CAAC;gBACL,CAAC;gBACD,MAAM,MAAM,GAAG,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;gBAC5D,WAAW,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;gBACxC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC;oBAC/B,MAAM,GAAG,GAAG,mBAAmB,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;oBACvD,IAAI,GAAG,CAAC,OAAO,EAAE,CAAC;wBAChB,KAAK,CAAC,IAAI,CAAC;4BACT,IAAI,EAAE,OAAO;4BACb,EAAE,EAAE,GAAG,CAAC,IAAI,CAAC,EAAE;4BACf,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,IAAI;4BACnB,KAAK,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAA4B;4BACxD,IAAI,EAAE,CAAC,GAAG,CAAC;4BACX,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM;4BACtC,MAAM,EAAE,MAAM,CAAC,MAAM;yBACtB,CAAC,CAAC;oBACL,CAAC;yBAAM,CAAC;wBACN,KAAK,MAAM,KAAK,IAAI,GAAG,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;4BACrC,IAAI,KAAK,CAAC,IAAI,KAAK,mBAAmB,EAAE,CAAC;gCACvC,KAAK,MAAM,CAAC,IAAK,KAAuC,CAAC,IAAI,EAAE,CAAC;oCAC9D,WAAW,CAAC,IAAI,CAAC;wCACf,IAAI,EAAE,mBAAmB;wCACzB,QAAQ,EAAE,OAAO;wCACjB,IAAI;wCACJ,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;wCACzC,OAAO,EAAE,wBAAwB,CAAC,oCAAoC;qCACvE,CAAC,CAAC;gCACL,CAAC;gCACD,SAAS;4BACX,CAAC;4BACD,WAAW,CAAC,IAAI,CAAC;gCACf,IAAI,EAAE,mBAAmB;gCACzB,QAAQ,EAAE,OAAO;gCACjB,IAAI;gCACJ,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gCAChD,OAAO,EAAE,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,OAAO,KAAK,KAAK,CAAC,OAAO,EAAE;6BAChE,CAAC,CAAC;wBACL,CAAC;oBACH,CAAC;gBACH,CAAC;gBACD,WAAW,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;gBAC9C,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC;gBAClC,SAAS;YACX,CAAC;YACD,yDAAyD;YACzD,IAAI,CAAC,MAAM,CAAC,MAAM;gBAAE,WAAW,GAAG,CAAC,GAAG,CAAC,CAAC;YACxC,MAAM,GAAG,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;YAC1C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,GAAG,EAAE,CAAC,EAAE;gBAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAE,CAAC,CAAC;YACtD,CAAC,GAAG,GAAG,GAAG,CAAC,CAAC;YACZ,SAAS;QACX,CAAC;QACD,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC7B,IAAI,CAAC,EAAE,CAAC;YACN,MAAM,KAAK,GAAG,CAAC,CAAC,CAAC,CAAE,CAAC,MAAM,CAAC;YAC3B,MAAM,OAAO,GAAG,CAAC,CAAC,CAAC,CAAE,CAAC,OAAO,CAAC,iBAAiB,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;YAC5D,MAAM,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;YACtB,IAAI,MAAM,GAAG,QAAQ,IAAI,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC;YAChE,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACd,IAAI,CAAC,GAAG,CAAC,CAAC;gBACV,MAAM,IAAI,GAAG,MAAM,CAAC;gBACpB,OAAO,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC;oBAAE,MAAM,GAAG,GAAG,IAAI,IAAI,CAAC,EAAE,EAAE,CAAC;YAC5D,CAAC;YACD,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YACxB,QAAQ,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAC5F,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,MAAM;YAAE,WAAW,GAAG,CAAC,GAAG,CAAC,CAAC;QACxC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAClB,CAAC,EAAE,CAAC;IACN,CAAC;IACD,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACpB,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC;AAC1C,CAAC;AAUD,sFAAsF;AACtF,SAAS,cAAc,CAAC,IAAY;IAClC,OAAO,IAAI,CAAC,OAAO,CAAC,qCAAqC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;AAC1F,CAAC;AAED,oEAAoE;AACpE,MAAM,SAAS,CAAC,CAAC,UAAU,CAAC,IAAkB;IAC5C,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACtC,IAAI,KAAyB,CAAC;IAC9B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACtC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAE,CAAC;QACpB,MAAM,CAAC,GAAG,sBAAsB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACzC,IAAI,CAAC,EAAE,CAAC;YACN,IAAI,CAAC,KAAK;gBAAE,KAAK,GAAG,CAAC,CAAC,CAAC,CAAE,CAAC,CAAC,CAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAE,CAAC,MAAM,CAAC,CAAC;iBAC9C,IAAI,CAAC,CAAC,CAAC,CAAE,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAE,CAAC,MAAM,IAAI,KAAK,CAAC,MAAM,IAAI,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;gBAAE,KAAK,GAAG,SAAS,CAAC;YACvG,SAAS;QACX,CAAC;QACD,IAAI,KAAK;YAAE,SAAS;QACpB,MAAM,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;IACzD,CAAC;AACH,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,IAAkB;IAClD,MAAM,GAAG,GAAgB,EAAE,CAAC;IAC5B,KAAK,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;QAC9C,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC;YAC3C,GAAG,CAAC,IAAI,CAAC;gBACP,IAAI,EAAE,CAAC,CAAC,CAAC,CAAY;gBACrB,EAAE,EAAE,CAAC,CAAC,CAAC,CAAE;gBACT,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;gBACtB,IAAI;gBACJ,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;aACV,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,+GAA+G;AAC/G,MAAM,UAAU,iBAAiB,CAAC,IAAkB;IAClD,MAAM,GAAG,GAAa,EAAE,CAAC;IACzB,KAAK,MAAM,EAAE,IAAI,EAAE,IAAI,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;QACxC,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,+BAA+B,CAAC;YAAE,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAE,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;IACvG,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,IAAkB;IACpD,MAAM,GAAG,GAAqC,EAAE,CAAC;IACjD,KAAK,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;QAC9C,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC;YAAE,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IACrF,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,uFAAuF;AACvF,MAAM,UAAU,SAAS,CAAC,IAAkB;IAC1C,OAAO,CAAC,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC7D,CAAC"}
|
package/dist/model.d.ts
ADDED
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
import { type Asset, type Brief, type ChecksFile, type Diagnostic, type GuideManifest, type ResolvedRecipe, type SourcesFile, type Track, type VerificationFile, type AssetsFile } from './contracts/index.js';
|
|
2
|
+
import { type DocNode, type Heading } from './markdown-doc.js';
|
|
3
|
+
import { BundleFiles, type BundleLimits, type BundleSource } from './source.js';
|
|
4
|
+
import { canonicalJson } from './util.js';
|
|
5
|
+
import { type LineLookup } from './yamlfile.js';
|
|
6
|
+
export interface ModelEntry {
|
|
7
|
+
track: Track;
|
|
8
|
+
id: string;
|
|
9
|
+
role: string;
|
|
10
|
+
path: string;
|
|
11
|
+
title: string;
|
|
12
|
+
/** Title taken from the first level-1 heading, when present. */
|
|
13
|
+
hasChapterHeading: boolean;
|
|
14
|
+
headings: Heading[];
|
|
15
|
+
nodes: DocNode[];
|
|
16
|
+
words: number;
|
|
17
|
+
digest: string;
|
|
18
|
+
/** Pointer index of this entry in guide.yaml, for diagnostics. */
|
|
19
|
+
pointer: string;
|
|
20
|
+
}
|
|
21
|
+
export interface GuideModel {
|
|
22
|
+
files: BundleFiles;
|
|
23
|
+
label: string;
|
|
24
|
+
guide?: GuideManifest;
|
|
25
|
+
brief?: Brief;
|
|
26
|
+
checks?: ChecksFile;
|
|
27
|
+
sources?: SourcesFile;
|
|
28
|
+
assets?: AssetsFile;
|
|
29
|
+
verification?: VerificationFile;
|
|
30
|
+
recipe?: ResolvedRecipe;
|
|
31
|
+
lines: Record<string, LineLookup>;
|
|
32
|
+
entries: ModelEntry[];
|
|
33
|
+
revision: string;
|
|
34
|
+
referenceRevision: string;
|
|
35
|
+
/** Diagnostics from reading and parsing (schemas, YAML, blocks, paths). */
|
|
36
|
+
diagnostics: Diagnostic[];
|
|
37
|
+
}
|
|
38
|
+
export declare function fileDigest(path: string, bytes: Uint8Array): string;
|
|
39
|
+
export declare function computeRevision(files: BundleFiles): string;
|
|
40
|
+
export declare function computeReferenceRevision(entries: ModelEntry[], brief: Brief | undefined): string;
|
|
41
|
+
/** Read a bundle from any source into one parsed model. Never throws for bad content. */
|
|
42
|
+
export declare function readGuide(input: BundleSource | BundleFiles, limits?: BundleLimits): Promise<GuideModel>;
|
|
43
|
+
export declare function entriesOf(model: GuideModel, track: Track): ModelEntry[];
|
|
44
|
+
export declare function guideTitle(guide: GuideManifest): string;
|
|
45
|
+
export declare function blocksOf(entry: ModelEntry): Extract<DocNode, {
|
|
46
|
+
kind: 'block';
|
|
47
|
+
}>[];
|
|
48
|
+
export declare function allBlocks(model: GuideModel): {
|
|
49
|
+
entry: ModelEntry;
|
|
50
|
+
block: import("./markdown-doc.js").BlockNode;
|
|
51
|
+
}[];
|
|
52
|
+
export declare function assetById(model: GuideModel, id: string): Asset | undefined;
|
|
53
|
+
export { canonicalJson };
|
|
54
|
+
//# sourceMappingURL=model.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"model.d.ts","sourceRoot":"","sources":["../src/model.ts"],"names":[],"mappings":"AACA,OAAO,EAcL,KAAK,KAAK,EACV,KAAK,KAAK,EACV,KAAK,UAAU,EACf,KAAK,UAAU,EAEf,KAAK,aAAa,EAClB,KAAK,cAAc,EACnB,KAAK,WAAW,EAChB,KAAK,KAAK,EACV,KAAK,gBAAgB,EACrB,KAAK,UAAU,EAEhB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAoB,KAAK,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,mBAAmB,CAAC;AACjF,OAAO,EACL,WAAW,EAIX,KAAK,YAAY,EACjB,KAAK,YAAY,EAClB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,aAAa,EAA0C,MAAM,WAAW,CAAC;AAClF,OAAO,EAAwC,KAAK,UAAU,EAAE,MAAM,eAAe,CAAC;AAGtF,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,KAAK,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,gEAAgE;IAChE,iBAAiB,EAAE,OAAO,CAAC;IAC3B,QAAQ,EAAE,OAAO,EAAE,CAAC;IACpB,KAAK,EAAE,OAAO,EAAE,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,kEAAkE;IAClE,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,WAAW,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,aAAa,CAAC;IACtB,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,YAAY,CAAC,EAAE,gBAAgB,CAAC;IAChC,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IAClC,OAAO,EAAE,UAAU,EAAE,CAAC;IACtB,QAAQ,EAAE,MAAM,CAAC;IACjB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,2EAA2E;IAC3E,WAAW,EAAE,UAAU,EAAE,CAAC;CAC3B;AAID,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,GAAG,MAAM,CAIlE;AAED,wBAAgB,eAAe,CAAC,KAAK,EAAE,WAAW,GAAG,MAAM,CAG1D;AAED,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,UAAU,EAAE,EAAE,KAAK,EAAE,KAAK,GAAG,SAAS,GAAG,MAAM,CAUhG;AAyCD,yFAAyF;AACzF,wBAAsB,SAAS,CAC7B,KAAK,EAAE,YAAY,GAAG,WAAW,EACjC,MAAM,GAAE,YAA6B,GACpC,OAAO,CAAC,UAAU,CAAC,CA6CrB;AA8HD,wBAAgB,SAAS,CAAC,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,KAAK,GAAG,UAAU,EAAE,CAEvE;AAED,wBAAgB,UAAU,CAAC,KAAK,EAAE,aAAa,GAAG,MAAM,CAEvD;AAED,wBAAgB,QAAQ,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAAC,OAAO,EAAE;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,CAAC,EAAE,CAEjF;AAED,wBAAgB,SAAS,CAAC,KAAK,EAAE,UAAU;;;IAE1C;AAED,wBAAgB,SAAS,CAAC,KAAK,EAAE,UAAU,EAAE,EAAE,EAAE,MAAM,GAAG,KAAK,GAAG,SAAS,CAE1E;AAED,OAAO,EAAE,aAAa,EAAE,CAAC"}
|
package/dist/model.js
ADDED
|
@@ -0,0 +1,244 @@
|
|
|
1
|
+
import { AssetsSchema, BLOCK_DEFINITIONS, BriefSchema, BUNDLE_FILES, ChecksSchema, EXTRA_ROLES, GuideSchema, HUMAN_ROLES, OPERATOR_ROLES, SourcesSchema, VerificationSchema, getGuideRecipe, isBlockType, MadeEasyError, } from './contracts/index.js';
|
|
2
|
+
import { parseMarkdownDoc } from './markdown-doc.js';
|
|
3
|
+
import { BundleFiles, DEFAULT_LIMITS, checkBundlePath, loadBundleFiles, } from './source.js';
|
|
4
|
+
import { canonicalJson, normalizeText, sha256Digest, wordCount } from './util.js';
|
|
5
|
+
import { parseYamlWithSchema, pointerFromPath } from './yamlfile.js';
|
|
6
|
+
import { proseText } from './markdown-doc.js';
|
|
7
|
+
const TEXT_EXT = /\.(md|markdown|ya?ml|json|txt|csv|css|html?|svg|js|mjs|cjs|ts|tsx|jsx|sh|ps1|toml)$/i;
|
|
8
|
+
export function fileDigest(path, bytes) {
|
|
9
|
+
return TEXT_EXT.test(path)
|
|
10
|
+
? sha256Digest(normalizeText(new TextDecoder().decode(bytes)))
|
|
11
|
+
: sha256Digest(bytes);
|
|
12
|
+
}
|
|
13
|
+
export function computeRevision(files) {
|
|
14
|
+
const lines = files.entries().map(([p, b]) => `${p}\u0000${fileDigest(p, b)}`);
|
|
15
|
+
return sha256Digest(lines.join('\n'));
|
|
16
|
+
}
|
|
17
|
+
export function computeReferenceRevision(entries, brief) {
|
|
18
|
+
const pins = brief?.operatorReference?.entries ?? [];
|
|
19
|
+
const byId = new Map(entries.filter((e) => e.track === 'operator').map((e) => [e.id, e]));
|
|
20
|
+
const lines = pins
|
|
21
|
+
.map((p) => {
|
|
22
|
+
const e = byId.get(p.id);
|
|
23
|
+
return e ? `${p.id}:${e.digest}` : undefined;
|
|
24
|
+
})
|
|
25
|
+
.filter(Boolean);
|
|
26
|
+
return sha256Digest(lines.join('\n'));
|
|
27
|
+
}
|
|
28
|
+
function mergeLines(model, path, lineOf) {
|
|
29
|
+
model.lines[path] = lineOf;
|
|
30
|
+
}
|
|
31
|
+
function readYamlFile(model, path, schema, required) {
|
|
32
|
+
const text = model.files.text(path);
|
|
33
|
+
if (text === undefined) {
|
|
34
|
+
if (required) {
|
|
35
|
+
model.diagnostics.push({
|
|
36
|
+
code: 'BUNDLE_FILE_MISSING',
|
|
37
|
+
severity: 'error',
|
|
38
|
+
path,
|
|
39
|
+
message: `${path} is required but missing.`,
|
|
40
|
+
});
|
|
41
|
+
}
|
|
42
|
+
return undefined;
|
|
43
|
+
}
|
|
44
|
+
const parsed = parseYamlWithSchema(path, text, schema);
|
|
45
|
+
mergeLines(model, path, parsed.lineOf);
|
|
46
|
+
model.diagnostics.push(...parsed.diagnostics);
|
|
47
|
+
return parsed.value;
|
|
48
|
+
}
|
|
49
|
+
function titleFor(entry, nodes, headings, recipe) {
|
|
50
|
+
const h1 = headings.find((h) => h.level === 1);
|
|
51
|
+
if (entry.title)
|
|
52
|
+
return { title: entry.title, chapter: Boolean(h1) };
|
|
53
|
+
if (h1)
|
|
54
|
+
return { title: h1.text.replace(/[`*_]/g, ''), chapter: true };
|
|
55
|
+
const role = recipe?.roleDetails.find((r) => r.role === entry.role)?.title ??
|
|
56
|
+
recipe?.operatorRoles.find((r) => r.role === entry.role)?.title;
|
|
57
|
+
void nodes;
|
|
58
|
+
return { title: role ?? entry.id, chapter: false };
|
|
59
|
+
}
|
|
60
|
+
/** Read a bundle from any source into one parsed model. Never throws for bad content. */
|
|
61
|
+
export async function readGuide(input, limits = DEFAULT_LIMITS) {
|
|
62
|
+
let files;
|
|
63
|
+
const diagnostics = [];
|
|
64
|
+
if (input instanceof BundleFiles)
|
|
65
|
+
files = input;
|
|
66
|
+
else {
|
|
67
|
+
const loaded = await loadBundleFiles(input, limits);
|
|
68
|
+
files = loaded.files;
|
|
69
|
+
diagnostics.push(...loaded.diagnostics);
|
|
70
|
+
}
|
|
71
|
+
const model = {
|
|
72
|
+
files,
|
|
73
|
+
label: files.label,
|
|
74
|
+
lines: {},
|
|
75
|
+
entries: [],
|
|
76
|
+
revision: computeRevision(files),
|
|
77
|
+
referenceRevision: '',
|
|
78
|
+
diagnostics,
|
|
79
|
+
};
|
|
80
|
+
model.guide = readYamlFile(model, BUNDLE_FILES.guide, GuideSchema, true);
|
|
81
|
+
model.brief = readYamlFile(model, BUNDLE_FILES.brief, BriefSchema, true);
|
|
82
|
+
model.checks = readYamlFile(model, BUNDLE_FILES.checks, ChecksSchema, true);
|
|
83
|
+
model.sources = readYamlFile(model, BUNDLE_FILES.sources, SourcesSchema, true);
|
|
84
|
+
model.assets = readYamlFile(model, BUNDLE_FILES.assets, AssetsSchema, true);
|
|
85
|
+
model.verification = readYamlFile(model, BUNDLE_FILES.verification, VerificationSchema, false);
|
|
86
|
+
if (model.guide) {
|
|
87
|
+
try {
|
|
88
|
+
model.recipe = getGuideRecipe(model.guide.recipe.id, model.guide.recipe.version);
|
|
89
|
+
}
|
|
90
|
+
catch (e) {
|
|
91
|
+
if (e instanceof MadeEasyError) {
|
|
92
|
+
model.diagnostics.push({
|
|
93
|
+
code: e.code,
|
|
94
|
+
severity: 'error',
|
|
95
|
+
path: BUNDLE_FILES.guide,
|
|
96
|
+
line: model.lines[BUNDLE_FILES.guide]?.(e.code === 'RECIPE_UNKNOWN' ? '/recipe/id' : '/recipe/version'),
|
|
97
|
+
pointer: e.code === 'RECIPE_UNKNOWN' ? '/recipe/id' : '/recipe/version',
|
|
98
|
+
message: e.message,
|
|
99
|
+
});
|
|
100
|
+
}
|
|
101
|
+
else
|
|
102
|
+
throw e;
|
|
103
|
+
}
|
|
104
|
+
readEntries(model, model.guide);
|
|
105
|
+
}
|
|
106
|
+
model.referenceRevision = computeReferenceRevision(model.entries, model.brief);
|
|
107
|
+
return model;
|
|
108
|
+
}
|
|
109
|
+
function readEntries(model, guide) {
|
|
110
|
+
const seenIds = new Map();
|
|
111
|
+
const seenPaths = new Map();
|
|
112
|
+
const seenBlocks = new Map();
|
|
113
|
+
for (const track of ['human', 'operator']) {
|
|
114
|
+
const roles = track === 'human' ? [...HUMAN_ROLES, ...EXTRA_ROLES] : [...OPERATOR_ROLES, ...EXTRA_ROLES];
|
|
115
|
+
guide.tracks[track].forEach((entry, index) => {
|
|
116
|
+
const pointer = pointerFromPath(['tracks', track, index]);
|
|
117
|
+
const line = model.lines[BUNDLE_FILES.guide]?.(pointer);
|
|
118
|
+
const diag = (code, message, sub = '') => model.diagnostics.push({
|
|
119
|
+
code,
|
|
120
|
+
severity: 'error',
|
|
121
|
+
path: BUNDLE_FILES.guide,
|
|
122
|
+
line: model.lines[BUNDLE_FILES.guide]?.(pointer + sub) ?? line,
|
|
123
|
+
pointer: pointer + sub,
|
|
124
|
+
message,
|
|
125
|
+
});
|
|
126
|
+
if (!roles.includes(entry.role)) {
|
|
127
|
+
diag('SCHEMA_INVALID', `Unknown ${track} role "${entry.role}". Allowed: ${roles.join(', ')}.`, '/role');
|
|
128
|
+
}
|
|
129
|
+
if (seenIds.has(entry.id)) {
|
|
130
|
+
diag('ID_DUPLICATE', `Entry id "${entry.id}" is already used by ${seenIds.get(entry.id)}.`, '/id');
|
|
131
|
+
}
|
|
132
|
+
seenIds.set(entry.id, `${track} entry ${index + 1}`);
|
|
133
|
+
const check = checkBundlePath(entry.path);
|
|
134
|
+
if (!check.ok) {
|
|
135
|
+
diag('BUNDLE_PATH_UNSAFE', `Entry path "${entry.path}" is unsafe: ${check.reason}.`, '/path');
|
|
136
|
+
return;
|
|
137
|
+
}
|
|
138
|
+
if (!check.path.startsWith(`${track}/`) || !check.path.endsWith('.md')) {
|
|
139
|
+
diag('SCHEMA_INVALID', `Entry path "${entry.path}" must be a Markdown file under ${track}/.`, '/path');
|
|
140
|
+
return;
|
|
141
|
+
}
|
|
142
|
+
if (seenPaths.has(check.path)) {
|
|
143
|
+
diag('ID_DUPLICATE', `Entry path "${entry.path}" is used by more than one entry.`, '/path');
|
|
144
|
+
}
|
|
145
|
+
seenPaths.set(check.path, entry.id);
|
|
146
|
+
const text = model.files.text(check.path);
|
|
147
|
+
if (text === undefined) {
|
|
148
|
+
diag('BUNDLE_FILE_MISSING', `Entry file ${check.path} does not exist.`, '/path');
|
|
149
|
+
return;
|
|
150
|
+
}
|
|
151
|
+
const parsed = parseMarkdownDoc(check.path, text);
|
|
152
|
+
model.diagnostics.push(...parsed.diagnostics);
|
|
153
|
+
// Block registry validation.
|
|
154
|
+
for (const node of parsed.nodes) {
|
|
155
|
+
if (node.kind !== 'block')
|
|
156
|
+
continue;
|
|
157
|
+
if (seenBlocks.has(node.id)) {
|
|
158
|
+
model.diagnostics.push({
|
|
159
|
+
code: 'ID_DUPLICATE',
|
|
160
|
+
severity: 'error',
|
|
161
|
+
path: check.path,
|
|
162
|
+
line: node.line,
|
|
163
|
+
blockId: node.id,
|
|
164
|
+
message: `Block id "${node.id}" is already used in ${seenBlocks.get(node.id)}.`,
|
|
165
|
+
});
|
|
166
|
+
}
|
|
167
|
+
seenBlocks.set(node.id, check.path);
|
|
168
|
+
if (!isBlockType(node.type)) {
|
|
169
|
+
model.diagnostics.push({
|
|
170
|
+
code: 'BLOCK_UNKNOWN_TYPE',
|
|
171
|
+
severity: 'error',
|
|
172
|
+
path: check.path,
|
|
173
|
+
line: node.line,
|
|
174
|
+
blockId: node.id,
|
|
175
|
+
message: `Unknown block type "${node.type}".`,
|
|
176
|
+
});
|
|
177
|
+
continue;
|
|
178
|
+
}
|
|
179
|
+
const result = BLOCK_DEFINITIONS[node.type].schema.safeParse(node.props);
|
|
180
|
+
if (!result.success) {
|
|
181
|
+
for (const issue of result.error.issues) {
|
|
182
|
+
if (issue.code === 'unrecognized_keys') {
|
|
183
|
+
for (const k of issue.keys) {
|
|
184
|
+
const ptr = pointerFromPath(['props', ...issue.path, k]);
|
|
185
|
+
model.diagnostics.push({
|
|
186
|
+
code: 'BLOCK_PROPS_INVALID',
|
|
187
|
+
severity: 'error',
|
|
188
|
+
path: check.path,
|
|
189
|
+
line: node.lineOf(ptr),
|
|
190
|
+
blockId: node.id,
|
|
191
|
+
pointer: ptr,
|
|
192
|
+
message: `${node.type}: unknown prop "${[...issue.path, k].join('.')}".`,
|
|
193
|
+
});
|
|
194
|
+
}
|
|
195
|
+
continue;
|
|
196
|
+
}
|
|
197
|
+
const ptr = pointerFromPath(['props', ...issue.path]);
|
|
198
|
+
model.diagnostics.push({
|
|
199
|
+
code: 'BLOCK_PROPS_INVALID',
|
|
200
|
+
severity: 'error',
|
|
201
|
+
path: check.path,
|
|
202
|
+
line: node.lineOf(ptr),
|
|
203
|
+
blockId: node.id,
|
|
204
|
+
pointer: ptr,
|
|
205
|
+
message: `${node.type}: ${issue.path.join('.') || 'props'}: ${issue.message}`,
|
|
206
|
+
});
|
|
207
|
+
}
|
|
208
|
+
}
|
|
209
|
+
}
|
|
210
|
+
const { title, chapter } = titleFor(entry, parsed.nodes, parsed.headings, model.recipe);
|
|
211
|
+
const words = parsed.nodes.reduce((n, node) => n + (node.kind === 'markdown' ? wordCount(proseText(node)) : 0), 0);
|
|
212
|
+
model.entries.push({
|
|
213
|
+
track,
|
|
214
|
+
id: entry.id,
|
|
215
|
+
role: entry.role,
|
|
216
|
+
path: check.path,
|
|
217
|
+
title,
|
|
218
|
+
hasChapterHeading: chapter,
|
|
219
|
+
headings: parsed.headings,
|
|
220
|
+
nodes: parsed.nodes,
|
|
221
|
+
words,
|
|
222
|
+
digest: sha256Digest(normalizeText(text)),
|
|
223
|
+
pointer,
|
|
224
|
+
});
|
|
225
|
+
});
|
|
226
|
+
}
|
|
227
|
+
}
|
|
228
|
+
export function entriesOf(model, track) {
|
|
229
|
+
return model.entries.filter((e) => e.track === track);
|
|
230
|
+
}
|
|
231
|
+
export function guideTitle(guide) {
|
|
232
|
+
return `${guide.subject.name} Made Easy`;
|
|
233
|
+
}
|
|
234
|
+
export function blocksOf(entry) {
|
|
235
|
+
return entry.nodes.filter((n) => n.kind === 'block');
|
|
236
|
+
}
|
|
237
|
+
export function allBlocks(model) {
|
|
238
|
+
return model.entries.flatMap((e) => blocksOf(e).map((b) => ({ entry: e, block: b })));
|
|
239
|
+
}
|
|
240
|
+
export function assetById(model, id) {
|
|
241
|
+
return model.assets?.assets?.find((a) => a.id === id);
|
|
242
|
+
}
|
|
243
|
+
export { canonicalJson };
|
|
244
|
+
//# sourceMappingURL=model.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"model.js","sourceRoot":"","sources":["../src/model.ts"],"names":[],"mappings":"AACA,OAAO,EACL,YAAY,EACZ,iBAAiB,EACjB,WAAW,EACX,YAAY,EACZ,YAAY,EACZ,WAAW,EACX,WAAW,EACX,WAAW,EACX,cAAc,EACd,aAAa,EACb,kBAAkB,EAClB,cAAc,EACd,WAAW,EAYX,aAAa,GACd,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,gBAAgB,EAA8B,MAAM,mBAAmB,CAAC;AACjF,OAAO,EACL,WAAW,EACX,cAAc,EACd,eAAe,EACf,eAAe,GAGhB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAClF,OAAO,EAAE,mBAAmB,EAAE,eAAe,EAAmB,MAAM,eAAe,CAAC;AACtF,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAoC9C,MAAM,QAAQ,GAAG,sFAAsF,CAAC;AAExG,MAAM,UAAU,UAAU,CAAC,IAAY,EAAE,KAAiB;IACxD,OAAO,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC;QACxB,CAAC,CAAC,YAAY,CAAC,aAAa,CAAC,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QAC9D,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;AAC1B,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,KAAkB;IAChD,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,SAAS,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;IAC/E,OAAO,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;AACxC,CAAC;AAED,MAAM,UAAU,wBAAwB,CAAC,OAAqB,EAAE,KAAwB;IACtF,MAAM,IAAI,GAAG,KAAK,EAAE,iBAAiB,EAAE,OAAO,IAAI,EAAE,CAAC;IACrD,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1F,MAAM,KAAK,GAAG,IAAI;SACf,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;QACT,MAAM,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QACzB,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;IAC/C,CAAC,CAAC;SACD,MAAM,CAAC,OAAO,CAAC,CAAC;IACnB,OAAO,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;AACxC,CAAC;AAED,SAAS,UAAU,CAAC,KAAiB,EAAE,IAAY,EAAE,MAAkB;IACrE,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC;AAC7B,CAAC;AAED,SAAS,YAAY,CACnB,KAAiB,EACjB,IAAY,EACZ,MAAS,EACT,QAAiB;IAEjB,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACpC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,IAAI,QAAQ,EAAE,CAAC;YACb,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC;gBACrB,IAAI,EAAE,qBAAqB;gBAC3B,QAAQ,EAAE,OAAO;gBACjB,IAAI;gBACJ,OAAO,EAAE,GAAG,IAAI,2BAA2B;aAC5C,CAAC,CAAC;QACL,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,MAAM,GAAG,mBAAmB,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;IACvD,UAAU,CAAC,KAAK,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;IACvC,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;IAC9C,OAAO,MAAM,CAAC,KAA+B,CAAC;AAChD,CAAC;AAED,SAAS,QAAQ,CAAC,KAAiB,EAAE,KAAgB,EAAE,QAAmB,EAAE,MAAkC;IAC5G,MAAM,EAAE,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC;IAC/C,IAAI,KAAK,CAAC,KAAK;QAAE,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,CAAC,EAAE,CAAC;IACrE,IAAI,EAAE;QAAE,OAAO,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IACvE,MAAM,IAAI,GACR,MAAM,EAAE,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,CAAC,EAAE,KAAK;QAC7D,MAAM,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC;IAClE,KAAK,KAAK,CAAC;IACX,OAAO,EAAE,KAAK,EAAE,IAAI,IAAI,KAAK,CAAC,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;AACrD,CAAC;AAED,yFAAyF;AACzF,MAAM,CAAC,KAAK,UAAU,SAAS,CAC7B,KAAiC,EACjC,SAAuB,cAAc;IAErC,IAAI,KAAkB,CAAC;IACvB,MAAM,WAAW,GAAiB,EAAE,CAAC;IACrC,IAAI,KAAK,YAAY,WAAW;QAAE,KAAK,GAAG,KAAK,CAAC;SAC3C,CAAC;QACJ,MAAM,MAAM,GAAG,MAAM,eAAe,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACpD,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;QACrB,WAAW,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;IAC1C,CAAC;IACD,MAAM,KAAK,GAAe;QACxB,KAAK;QACL,KAAK,EAAE,KAAK,CAAC,KAAK;QAClB,KAAK,EAAE,EAAE;QACT,OAAO,EAAE,EAAE;QACX,QAAQ,EAAE,eAAe,CAAC,KAAK,CAAC;QAChC,iBAAiB,EAAE,EAAE;QACrB,WAAW;KACZ,CAAC;IAEF,KAAK,CAAC,KAAK,GAAG,YAAY,CAAC,KAAK,EAAE,YAAY,CAAC,KAAK,EAAE,WAAW,EAAE,IAAI,CAAC,CAAC;IACzE,KAAK,CAAC,KAAK,GAAG,YAAY,CAAC,KAAK,EAAE,YAAY,CAAC,KAAK,EAAE,WAAW,EAAE,IAAI,CAAC,CAAC;IACzE,KAAK,CAAC,MAAM,GAAG,YAAY,CAAC,KAAK,EAAE,YAAY,CAAC,MAAM,EAAE,YAAY,EAAE,IAAI,CAAC,CAAC;IAC5E,KAAK,CAAC,OAAO,GAAG,YAAY,CAAC,KAAK,EAAE,YAAY,CAAC,OAAO,EAAE,aAAa,EAAE,IAAI,CAAC,CAAC;IAC/E,KAAK,CAAC,MAAM,GAAG,YAAY,CAAC,KAAK,EAAE,YAAY,CAAC,MAAM,EAAE,YAAY,EAAE,IAAI,CAAC,CAAC;IAC5E,KAAK,CAAC,YAAY,GAAG,YAAY,CAAC,KAAK,EAAE,YAAY,CAAC,YAAY,EAAE,kBAAkB,EAAE,KAAK,CAAC,CAAC;IAE/F,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;QAChB,IAAI,CAAC;YACH,KAAK,CAAC,MAAM,GAAG,cAAc,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,EAAE,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACnF,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,CAAC,YAAY,aAAa,EAAE,CAAC;gBAC/B,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC;oBACrB,IAAI,EAAE,CAAC,CAAC,IAAI;oBACZ,QAAQ,EAAE,OAAO;oBACjB,IAAI,EAAE,YAAY,CAAC,KAAK;oBACxB,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,gBAAgB,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,iBAAiB,CAAC;oBACvG,OAAO,EAAE,CAAC,CAAC,IAAI,KAAK,gBAAgB,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,iBAAiB;oBACvE,OAAO,EAAE,CAAC,CAAC,OAAO;iBACnB,CAAC,CAAC;YACL,CAAC;;gBAAM,MAAM,CAAC,CAAC;QACjB,CAAC;QACD,WAAW,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC;IACD,KAAK,CAAC,iBAAiB,GAAG,wBAAwB,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;IAC/E,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,WAAW,CAAC,KAAiB,EAAE,KAAoB;IAC1D,MAAM,OAAO,GAAG,IAAI,GAAG,EAAkB,CAAC;IAC1C,MAAM,SAAS,GAAG,IAAI,GAAG,EAAkB,CAAC;IAC5C,MAAM,UAAU,GAAG,IAAI,GAAG,EAAkB,CAAC;IAC7C,KAAK,MAAM,KAAK,IAAI,CAAC,OAAO,EAAE,UAAU,CAAU,EAAE,CAAC;QACnD,MAAM,KAAK,GACT,KAAK,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,WAAW,EAAE,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,cAAc,EAAE,GAAG,WAAW,CAAC,CAAC;QAC7F,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;YAC3C,MAAM,OAAO,GAAG,eAAe,CAAC,CAAC,QAAQ,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;YAC1D,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC;YACxD,MAAM,IAAI,GAAG,CAAC,IAAY,EAAE,OAAe,EAAE,GAAG,GAAG,EAAE,EAAE,EAAE,CACvD,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC;gBACrB,IAAI;gBACJ,QAAQ,EAAE,OAAO;gBACjB,IAAI,EAAE,YAAY,CAAC,KAAK;gBACxB,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC,OAAO,GAAG,GAAG,CAAC,IAAI,IAAI;gBAC9D,OAAO,EAAE,OAAO,GAAG,GAAG;gBACtB,OAAO;aACR,CAAC,CAAC;YACL,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;gBAChC,IAAI,CAAC,gBAAgB,EAAE,WAAW,KAAK,UAAU,KAAK,CAAC,IAAI,eAAe,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;YAC1G,CAAC;YACD,IAAI,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,CAAC;gBAC1B,IAAI,CAAC,cAAc,EAAE,aAAa,KAAK,CAAC,EAAE,wBAAwB,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YACrG,CAAC;YACD,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,EAAE,GAAG,KAAK,UAAU,KAAK,GAAG,CAAC,EAAE,CAAC,CAAC;YACrD,MAAM,KAAK,GAAG,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAC1C,IAAI,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC;gBACd,IAAI,CAAC,oBAAoB,EAAE,eAAe,KAAK,CAAC,IAAI,gBAAgB,KAAK,CAAC,MAAM,GAAG,EAAE,OAAO,CAAC,CAAC;gBAC9F,OAAO;YACT,CAAC;YACD,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,KAAK,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;gBACvE,IAAI,CAAC,gBAAgB,EAAE,eAAe,KAAK,CAAC,IAAI,mCAAmC,KAAK,IAAI,EAAE,OAAO,CAAC,CAAC;gBACvG,OAAO;YACT,CAAC;YACD,IAAI,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC9B,IAAI,CAAC,cAAc,EAAE,eAAe,KAAK,CAAC,IAAI,mCAAmC,EAAE,OAAO,CAAC,CAAC;YAC9F,CAAC;YACD,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC;YACpC,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAC1C,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;gBACvB,IAAI,CAAC,qBAAqB,EAAE,cAAc,KAAK,CAAC,IAAI,kBAAkB,EAAE,OAAO,CAAC,CAAC;gBACjF,OAAO;YACT,CAAC;YACD,MAAM,MAAM,GAAG,gBAAgB,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAClD,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;YAC9C,6BAA6B;YAC7B,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;gBAChC,IAAI,IAAI,CAAC,IAAI,KAAK,OAAO;oBAAE,SAAS;gBACpC,IAAI,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC;oBAC5B,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC;wBACrB,IAAI,EAAE,cAAc;wBACpB,QAAQ,EAAE,OAAO;wBACjB,IAAI,EAAE,KAAK,CAAC,IAAI;wBAChB,IAAI,EAAE,IAAI,CAAC,IAAI;wBACf,OAAO,EAAE,IAAI,CAAC,EAAE;wBAChB,OAAO,EAAE,aAAa,IAAI,CAAC,EAAE,wBAAwB,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG;qBAChF,CAAC,CAAC;gBACL,CAAC;gBACD,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;gBACpC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;oBAC5B,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC;wBACrB,IAAI,EAAE,oBAAoB;wBAC1B,QAAQ,EAAE,OAAO;wBACjB,IAAI,EAAE,KAAK,CAAC,IAAI;wBAChB,IAAI,EAAE,IAAI,CAAC,IAAI;wBACf,OAAO,EAAE,IAAI,CAAC,EAAE;wBAChB,OAAO,EAAE,uBAAuB,IAAI,CAAC,IAAI,IAAI;qBAC9C,CAAC,CAAC;oBACH,SAAS;gBACX,CAAC;gBACD,MAAM,MAAM,GAAG,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACzE,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;oBACpB,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;wBACxC,IAAI,KAAK,CAAC,IAAI,KAAK,mBAAmB,EAAE,CAAC;4BACvC,KAAK,MAAM,CAAC,IAAK,KAAuC,CAAC,IAAI,EAAE,CAAC;gCAC9D,MAAM,GAAG,GAAG,eAAe,CAAC,CAAC,OAAO,EAAE,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;gCACzD,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC;oCACrB,IAAI,EAAE,qBAAqB;oCAC3B,QAAQ,EAAE,OAAO;oCACjB,IAAI,EAAE,KAAK,CAAC,IAAI;oCAChB,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC;oCACtB,OAAO,EAAE,IAAI,CAAC,EAAE;oCAChB,OAAO,EAAE,GAAG;oCACZ,OAAO,EAAE,GAAG,IAAI,CAAC,IAAI,mBAAmB,CAAC,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI;iCACzE,CAAC,CAAC;4BACL,CAAC;4BACD,SAAS;wBACX,CAAC;wBACD,MAAM,GAAG,GAAG,eAAe,CAAC,CAAC,OAAO,EAAE,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;wBACtD,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC;4BACrB,IAAI,EAAE,qBAAqB;4BAC3B,QAAQ,EAAE,OAAO;4BACjB,IAAI,EAAE,KAAK,CAAC,IAAI;4BAChB,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC;4BACtB,OAAO,EAAE,IAAI,CAAC,EAAE;4BAChB,OAAO,EAAE,GAAG;4BACZ,OAAO,EAAE,GAAG,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,OAAO,KAAK,KAAK,CAAC,OAAO,EAAE;yBAC9E,CAAC,CAAC;oBACL,CAAC;gBACH,CAAC;YACH,CAAC;YACD,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YACxF,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,CAC/B,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAC5E,CAAC,CACF,CAAC;YACF,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC;gBACjB,KAAK;gBACL,EAAE,EAAE,KAAK,CAAC,EAAE;gBACZ,IAAI,EAAE,KAAK,CAAC,IAAI;gBAChB,IAAI,EAAE,KAAK,CAAC,IAAI;gBAChB,KAAK;gBACL,iBAAiB,EAAE,OAAO;gBAC1B,QAAQ,EAAE,MAAM,CAAC,QAAQ;gBACzB,KAAK,EAAE,MAAM,CAAC,KAAK;gBACnB,KAAK;gBACL,MAAM,EAAE,YAAY,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;gBACzC,OAAO;aACR,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;AACH,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,KAAiB,EAAE,KAAY;IACvD,OAAO,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,KAAK,CAAC,CAAC;AACxD,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,KAAoB;IAC7C,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,YAAY,CAAC;AAC3C,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,KAAiB;IACxC,OAAO,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAA4C,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC;AACjG,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,KAAiB;IACzC,OAAO,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AACxF,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,KAAiB,EAAE,EAAU;IACrD,OAAO,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;AACxD,CAAC;AAED,OAAO,EAAE,aAAa,EAAE,CAAC"}
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
import type { Brief, ChecksFile, GuideManifest, SourcesFile, Track } from './contracts/index.js';
|
|
2
|
+
import { type GuideModel } from './model.js';
|
|
3
|
+
export interface NormalizedBlock {
|
|
4
|
+
kind: 'block';
|
|
5
|
+
id: string;
|
|
6
|
+
type: string;
|
|
7
|
+
props: Record<string, unknown>;
|
|
8
|
+
}
|
|
9
|
+
export interface NormalizedMarkdown {
|
|
10
|
+
kind: 'markdown';
|
|
11
|
+
source: string;
|
|
12
|
+
}
|
|
13
|
+
export interface NormalizedEntry {
|
|
14
|
+
id: string;
|
|
15
|
+
role: string;
|
|
16
|
+
title: string;
|
|
17
|
+
path: string;
|
|
18
|
+
digest: string;
|
|
19
|
+
headings: {
|
|
20
|
+
level: number;
|
|
21
|
+
text: string;
|
|
22
|
+
anchor: string;
|
|
23
|
+
explicit: boolean;
|
|
24
|
+
}[];
|
|
25
|
+
nodes: (NormalizedBlock | NormalizedMarkdown)[];
|
|
26
|
+
}
|
|
27
|
+
/** The single normalized guide from which every output is rendered. JSON-serializable. */
|
|
28
|
+
export interface NormalizedGuide {
|
|
29
|
+
schemaVersion: string;
|
|
30
|
+
guideId: string;
|
|
31
|
+
jobId: string;
|
|
32
|
+
locale: string;
|
|
33
|
+
title: string;
|
|
34
|
+
subject: GuideManifest['subject'];
|
|
35
|
+
recipe: GuideManifest['recipe'];
|
|
36
|
+
theme: GuideManifest['theme'];
|
|
37
|
+
revision: string;
|
|
38
|
+
referenceRevision: string;
|
|
39
|
+
brief: Brief | undefined;
|
|
40
|
+
checks: ChecksFile | undefined;
|
|
41
|
+
sources: SourcesFile | undefined;
|
|
42
|
+
assets: {
|
|
43
|
+
id: string;
|
|
44
|
+
path: string;
|
|
45
|
+
mediaType: string;
|
|
46
|
+
digest: string;
|
|
47
|
+
alt?: string;
|
|
48
|
+
decorative?: boolean;
|
|
49
|
+
visibility: string;
|
|
50
|
+
}[];
|
|
51
|
+
tracks: Record<Track, NormalizedEntry[]>;
|
|
52
|
+
/** Decisions, pauses and checks, used to prove parity across presets and adapters. */
|
|
53
|
+
facts: {
|
|
54
|
+
decisions: string[];
|
|
55
|
+
decisionOptions: string[];
|
|
56
|
+
pauses: string[];
|
|
57
|
+
checks: string[];
|
|
58
|
+
results: string[];
|
|
59
|
+
examples: string[];
|
|
60
|
+
};
|
|
61
|
+
}
|
|
62
|
+
export declare function toNormalizedGuide(model: GuideModel): NormalizedGuide;
|
|
63
|
+
//# sourceMappingURL=normalize.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"normalize.d.ts","sourceRoot":"","sources":["../src/normalize.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,UAAU,EAAE,aAAa,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAC;AACjG,OAAO,EAAyB,KAAK,UAAU,EAAE,MAAM,YAAY,CAAC;AAGpE,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,OAAO,CAAC;IACd,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAChC;AACD,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,UAAU,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;CAChB;AACD,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,OAAO,CAAA;KAAE,EAAE,CAAC;IAC/E,KAAK,EAAE,CAAC,eAAe,GAAG,kBAAkB,CAAC,EAAE,CAAC;CACjD;AAED,0FAA0F;AAC1F,MAAM,WAAW,eAAe;IAC9B,aAAa,EAAE,MAAM,CAAC;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,aAAa,CAAC,SAAS,CAAC,CAAC;IAClC,MAAM,EAAE,aAAa,CAAC,QAAQ,CAAC,CAAC;IAChC,KAAK,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC;IAC9B,QAAQ,EAAE,MAAM,CAAC;IACjB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,KAAK,EAAE,KAAK,GAAG,SAAS,CAAC;IACzB,MAAM,EAAE,UAAU,GAAG,SAAS,CAAC;IAC/B,OAAO,EAAE,WAAW,GAAG,SAAS,CAAC;IACjC,MAAM,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,OAAO,CAAC;QAAC,UAAU,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IAClI,MAAM,EAAE,MAAM,CAAC,KAAK,EAAE,eAAe,EAAE,CAAC,CAAC;IACzC,sFAAsF;IACtF,KAAK,EAAE;QACL,SAAS,EAAE,MAAM,EAAE,CAAC;QACpB,eAAe,EAAE,MAAM,EAAE,CAAC;QAC1B,MAAM,EAAE,MAAM,EAAE,CAAC;QACjB,MAAM,EAAE,MAAM,EAAE,CAAC;QACjB,OAAO,EAAE,MAAM,EAAE,CAAC;QAClB,QAAQ,EAAE,MAAM,EAAE,CAAC;KACpB,CAAC;CACH;AAED,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,UAAU,GAAG,eAAe,CAqDpE"}
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
import { allBlocks, guideTitle } from './model.js';
|
|
2
|
+
import { entriesOf } from './model.js';
|
|
3
|
+
export function toNormalizedGuide(model) {
|
|
4
|
+
const guide = model.guide;
|
|
5
|
+
const entry = (track) => entriesOf(model, track).map((e) => ({
|
|
6
|
+
id: e.id,
|
|
7
|
+
role: e.role,
|
|
8
|
+
title: e.title,
|
|
9
|
+
path: e.path,
|
|
10
|
+
digest: e.digest,
|
|
11
|
+
headings: e.headings.map((h) => ({ level: h.level, text: h.text, anchor: h.anchor, explicit: h.explicit })),
|
|
12
|
+
nodes: e.nodes.map((n) => n.kind === 'markdown'
|
|
13
|
+
? { kind: 'markdown', source: n.source }
|
|
14
|
+
: { kind: 'block', id: n.id, type: n.type, props: n.props }),
|
|
15
|
+
}));
|
|
16
|
+
const blocks = allBlocks(model).map((b) => b.block);
|
|
17
|
+
const decisions = blocks.filter((b) => b.type === 'decision');
|
|
18
|
+
return {
|
|
19
|
+
schemaVersion: guide.schemaVersion,
|
|
20
|
+
guideId: guide.guideId,
|
|
21
|
+
jobId: guide.jobId,
|
|
22
|
+
locale: guide.locale,
|
|
23
|
+
title: guideTitle(guide),
|
|
24
|
+
subject: guide.subject,
|
|
25
|
+
recipe: guide.recipe,
|
|
26
|
+
theme: guide.theme,
|
|
27
|
+
revision: model.revision,
|
|
28
|
+
referenceRevision: model.referenceRevision,
|
|
29
|
+
brief: model.brief,
|
|
30
|
+
checks: model.checks,
|
|
31
|
+
sources: model.sources,
|
|
32
|
+
assets: (model.assets?.assets ?? []).map((a) => ({
|
|
33
|
+
id: a.id,
|
|
34
|
+
path: a.path,
|
|
35
|
+
mediaType: a.mediaType,
|
|
36
|
+
digest: a.digest,
|
|
37
|
+
alt: a.alt,
|
|
38
|
+
decorative: a.decorative,
|
|
39
|
+
visibility: a.visibility ?? 'private',
|
|
40
|
+
})),
|
|
41
|
+
tracks: { human: entry('human'), operator: entry('operator') },
|
|
42
|
+
facts: {
|
|
43
|
+
decisions: decisions.map((b) => b.id).sort(),
|
|
44
|
+
decisionOptions: decisions
|
|
45
|
+
.flatMap((b) => (b.props.options ?? []).map((o) => `${b.id}/${o.id}`))
|
|
46
|
+
.sort(),
|
|
47
|
+
pauses: (model.brief?.pauseRules ?? []).map((p) => p.id).sort(),
|
|
48
|
+
checks: (model.brief?.acceptanceChecks ?? []).slice().sort(),
|
|
49
|
+
results: (model.checks?.results ?? []).map((r) => r.id).sort(),
|
|
50
|
+
examples: blocks.filter((b) => b.type === 'example').map((b) => b.id).sort(),
|
|
51
|
+
},
|
|
52
|
+
};
|
|
53
|
+
}
|
|
54
|
+
//# sourceMappingURL=normalize.js.map
|