@astryxdesign/cli 0.6.3-canary.b7cc8b8 → 0.6.3-canary.bcf01fe

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.
@@ -16,40 +16,43 @@
16
16
  */
17
17
  export function loadDocsCatalog(cwd?: string): Promise<DocsCatalog>;
18
18
  /**
19
- * @param {string} docPath
20
- * @param {{lang?: string|null}} [opts]
21
- * @returns {Promise<import('./docs.type.mjs').DocsDetailResponse['data']>}
19
+ * The overlay languages a topic ships for its own file or any extension.
20
+ * @param {import('../../foundation/discovery/docs-discovery.mjs').DocsTopicEntry} entry
21
+ * @returns {string[]}
22
22
  */
23
- export function loadReferenceDocs(docPath: string, { lang }?: {
24
- lang?: string | null;
25
- }): Promise<import("./docs.type.mjs").DocsDetailResponse["data"]>;
23
+ export function overlayLanguages(entry: import("../../foundation/discovery/docs-discovery.mjs").DocsTopicEntry): string[];
26
24
  /**
27
- * Load one catalog entry: its own doc, plus any extension an integration
28
- * merged onto it, in configuration order.
29
- *
30
- * A localization overlay applies to each file before the extensions are
31
- * merged, so an extension written in the base language stays readable under
32
- * `--dense`/`--zh` (it replaces its own sections and leaves the rest
33
- * translated) rather than being dropped.
34
- *
25
+ * One topic, lowered for `lang`: overlaid, extensions merged, keys stamped.
26
+ * Memoized per catalog, so a read that references a topic twice loads it once.
27
+ * Every read of the catalog shares the memoized node, so it is frozen; the
28
+ * lenses hand readers copies.
29
+ * @param {DocsCatalog} catalog
35
30
  * @param {import('../../foundation/discovery/docs-discovery.mjs').DocsTopicEntry} entry
36
- * @param {{lang?: string|null}} [opts]
37
- * @returns {Promise<import('./docs.type.mjs').DocsDetailResponse['data']>}
31
+ * @param {string | null} [lang]
32
+ * @returns {Promise<import('../../foundation/doc-compiler/compile.mjs').CompiledReferenceNode>}
38
33
  */
39
- export function loadTopicDoc(entry: import("../../foundation/discovery/docs-discovery.mjs").DocsTopicEntry, { lang }?: {
40
- lang?: string | null;
41
- }): Promise<import("./docs.type.mjs").DocsDetailResponse["data"]>;
34
+ export function lowerTopic(catalog: DocsCatalog, entry: import("../../foundation/discovery/docs-discovery.mjs").DocsTopicEntry, lang?: string | null): Promise<import("../../foundation/doc-compiler/compile.mjs").CompiledReferenceNode>;
42
35
  /**
43
- * The overlay languages a topic ships for its own file or any extension.
36
+ * How a token reference finds its target: the topic it names in `catalog`,
37
+ * lowered for the same language.
38
+ * @param {DocsCatalog} catalog
39
+ * @param {string | null} lang
40
+ * @returns {(topic: string) => Promise<import('../../foundation/doc-compiler/compile.mjs').CompiledReferenceNode | null>}
41
+ */
42
+ export function referenceTargets(catalog: DocsCatalog, lang: string | null): (topic: string) => Promise<import("../../foundation/doc-compiler/compile.mjs").CompiledReferenceNode | null>;
43
+ /**
44
+ * One topic, compiled for `lang`: lowered, then every token reference linked.
45
+ * @param {DocsCatalog} catalog
44
46
  * @param {import('../../foundation/discovery/docs-discovery.mjs').DocsTopicEntry} entry
45
- * @returns {string[]}
47
+ * @param {string | null} [lang]
48
+ * @returns {Promise<import('../../foundation/doc-compiler/compile.mjs').CompiledReferenceNode>}
46
49
  */
47
- export function overlayLanguages(entry: import("../../foundation/discovery/docs-discovery.mjs").DocsTopicEntry): string[];
50
+ export function compileTopic(catalog: DocsCatalog, entry: import("../../foundation/discovery/docs-discovery.mjs").DocsTopicEntry, lang?: string | null): Promise<import("../../foundation/doc-compiler/compile.mjs").CompiledReferenceNode>;
48
51
  /**
49
52
  * Resolve `topic` against the project's catalog (throwing `ERR_UNKNOWN_TOPIC`
50
- * when unmatched), and load it with any --dense/--zh overlay and any
51
- * integration extension applied. Shared by the detail and section leaves so
52
- * topic normalization and unknown-topic handling live in exactly one place.
53
+ * when unmatched) and lower it with any --dense/--zh overlay and any
54
+ * integration extension applied. Shared by the leaves so topic normalization
55
+ * and unknown-topic handling live in exactly one place.
53
56
  *
54
57
  * @param {string} topic
55
58
  * @param {object} [options]
@@ -59,7 +62,7 @@ export function overlayLanguages(entry: import("../../foundation/discovery/docs-
59
62
  * @param {string} [options.cwd]
60
63
  * @returns {Promise<{
61
64
  * catalog: DocsCatalog,
62
- * docsData: import('./docs.type.mjs').DocsDetailResponse['data'],
65
+ * node: import('../../foundation/doc-compiler/compile.mjs').CompiledReferenceNode,
63
66
  * lang: string | null,
64
67
  * }>}
65
68
  */
@@ -70,7 +73,7 @@ export function resolveTopicDocs(topic: string, options?: {
70
73
  cwd?: string | undefined;
71
74
  }): Promise<{
72
75
  catalog: DocsCatalog;
73
- docsData: import("./docs.type.mjs").DocsDetailResponse["data"];
76
+ node: import("../../foundation/doc-compiler/compile.mjs").CompiledReferenceNode;
74
77
  lang: string | null;
75
78
  }>;
76
79
  /** The localized overlays a docs read can apply. */
@@ -7,29 +7,24 @@
7
7
  * packages/cli/assets/docs/{topic}.doc.mjs plus every topic the configured
8
8
  * integrations contribute — and, when a --dense/--zh overlay is requested,
9
9
  * the sibling {topic}.doc.dense.mjs / {topic}.doc.zh.mjs.
10
- * @output Catalog access, overlay- and extension-merged reference-doc data,
11
- * and a combined resolve step ({catalog, docsData}) that the detail and
12
- * section leaves share.
13
- * @position Sits beside docs.mjs (api/docs/). Owns everything ≥2 leaves need so
14
- * no leaf re-implements resolution, overlay merging, or unknown-topic
15
- * handling. Discovery itself lives in foundation/discovery/docs-discovery,
16
- * which api/search and the agent-docs block read through the same catalog.
10
+ * @output Catalog access, the compiler input for a topic, and the compiled
11
+ * node for it: lowered (overlaid, extensions merged, keys stamped) or linked
12
+ * (token references resolved too), memoized per catalog.
13
+ * @position Sits beside docs.mjs (api/docs/). Loads authored files and hands
14
+ * them to foundation/doc-compiler, so no leaf, doctor check or search loads,
15
+ * merges, or resolves docs on its own. Discovery itself lives in
16
+ * foundation/discovery/docs-discovery, which the catalog comes from.
17
17
  */
18
18
 
19
19
  import * as fs from 'node:fs';
20
20
  import * as path from 'node:path';
21
21
  import {pathToFileURL} from 'node:url';
22
22
  import {Project} from '../../foundation/config/project.mjs';
23
+ import {DocsCatalog} from '../../foundation/discovery/docs-discovery.mjs';
23
24
  import {
24
- DocsCatalog,
25
- mergeTopic,
26
- problemsInTopic,
27
- withSourceTitle,
28
- } from '../../foundation/discovery/docs-discovery.mjs';
29
- import {
30
- sectionKeyProblems,
31
- withSectionKeys,
32
- } from '../../foundation/discovery/docs-section-key.mjs';
25
+ linkReferenceTopic,
26
+ lowerReferenceTopic,
27
+ } from '../../foundation/doc-compiler/compile.mjs';
33
28
  import {AstryxError} from '../error.mjs';
34
29
  import {ERROR_CODES} from '../../foundation/response/error-codes.mjs';
35
30
  import {parseDoc} from '../../authoring/doctypes/parse.mjs';
@@ -56,108 +51,6 @@ export async function loadDocsCatalog(cwd = process.cwd()) {
56
51
  }
57
52
  }
58
53
 
59
- /**
60
- * @param {string} docPath
61
- * @param {{lang?: string|null}} [opts]
62
- * @returns {Promise<import('./docs.type.mjs').DocsDetailResponse['data']>}
63
- */
64
- export async function loadReferenceDocs(docPath, {lang} = {}) {
65
- const mod = await import(pathToFileURL(docPath).href);
66
- const parsed = parseDoc(mod.docs ?? mod.default, path.basename(docPath));
67
- if (!('sections' in parsed)) {
68
- throw new Error(`${path.basename(docPath)} is not a reference document.`);
69
- }
70
- const problems = problemsInTopic(parsed);
71
- if (problems.length > 0) {
72
- throw new Error(
73
- `${path.basename(docPath)} is invalid: ${problems.join('; ')}`,
74
- );
75
- }
76
- const docs = parsed;
77
- if (!lang || lang === 'en') return docs;
78
-
79
- const translationPath = overlayPath(docPath, lang);
80
- if (!fs.existsSync(translationPath)) return docs;
81
-
82
- const translationMod = await import(pathToFileURL(translationPath).href);
83
- const translation = translationMod.docsZh || translationMod.docsDense;
84
- if (!translation) return docs;
85
-
86
- // Overlays are keyed to a base section by title (`section`), not by array
87
- // position. Position-keying silently grafted each overlay title onto whatever
88
- // base section happened to share its index, so an overlay that omitted or
89
- // reordered a section corrupted every section after it — `docs tokens --dense`
90
- // printed the colour table under a "Spacing" heading (#2182). An overlay may
91
- // now cover any subset of sections, in any order; sections it does not name
92
- // keep their base content.
93
- /** @type {Map<string, any>} */
94
- const bySection = new Map();
95
- for (const ts of translation.sections ?? []) {
96
- if (ts?.section != null) bySection.set(ts.section, ts);
97
- }
98
-
99
- return {
100
- ...docs,
101
- description: translation.description || docs.description,
102
- sections: docs.sections.map(
103
- (
104
- /** @type {import('@astryxdesign/cli/authoring').ReferenceSection} */ section,
105
- ) => {
106
- const ts = bySection.get(section.title);
107
- if (!ts) return section;
108
- const localized = {
109
- ...section,
110
- title: ts.title || section.title,
111
- content: section.content.map(
112
- (
113
- /** @type {import('@astryxdesign/cli/authoring').ReferenceContentBlock} */ block,
114
- /** @type {number} */ bi,
115
- ) => {
116
- const tb = ts.content?.[bi];
117
- if (!tb) return block;
118
- if (tb.type === 'prose' && block.type === 'prose')
119
- return {...block, text: tb.text};
120
- if (tb.type === 'list' && block.type === 'list')
121
- return {...block, items: tb.items};
122
- return block;
123
- },
124
- ),
125
- };
126
- return withSourceTitle(localized, section.title);
127
- },
128
- ),
129
- };
130
- }
131
-
132
- /**
133
- * Load one catalog entry: its own doc, plus any extension an integration
134
- * merged onto it, in configuration order.
135
- *
136
- * A localization overlay applies to each file before the extensions are
137
- * merged, so an extension written in the base language stays readable under
138
- * `--dense`/`--zh` (it replaces its own sections and leaves the rest
139
- * translated) rather than being dropped.
140
- *
141
- * @param {import('../../foundation/discovery/docs-discovery.mjs').DocsTopicEntry} entry
142
- * @param {{lang?: string|null}} [opts]
143
- * @returns {Promise<import('./docs.type.mjs').DocsDetailResponse['data']>}
144
- */
145
- export async function loadTopicDoc(entry, {lang} = {}) {
146
- let doc = await loadReferenceDocs(entry.path, {lang});
147
- for (const extension of entry.extensions) {
148
- doc = mergeTopic(doc, await loadReferenceDocs(extension.path, {lang}));
149
- // Merging matches on keys, so this holds unless merge itself regresses.
150
- const problems = sectionKeyProblems(doc.sections);
151
- if (problems.length > 0) {
152
- throw new Error(
153
- `${path.basename(extension.path)}, extending ${entry.name}, leaves two sections with one key: ${problems.join('; ')}`,
154
- );
155
- }
156
- }
157
- // Derived keys are stamped only now, so they never take part in merging.
158
- return withSectionKeys(doc);
159
- }
160
-
161
54
  /** The localized overlays a docs read can apply. */
162
55
  export const OVERLAY_LANGUAGES = ['zh', 'dense'];
163
56
 
@@ -186,11 +79,148 @@ export function overlayLanguages(entry) {
186
79
  );
187
80
  }
188
81
 
82
+ /**
83
+ * The overlay a read applies: none for the authored language.
84
+ * @param {string | null | undefined} lang
85
+ * @returns {string | null}
86
+ */
87
+ function overlayLanguage(lang) {
88
+ return lang && lang !== 'en' ? lang : null;
89
+ }
90
+
91
+ /**
92
+ * Load one authored file and the overlay for `lang`. A failure is recorded on
93
+ * the result, not thrown, so the compiler reports it in reading order.
94
+ * @param {string} docPath
95
+ * @param {string | null} lang
96
+ * @returns {Promise<import('../../foundation/doc-compiler/compile.mjs').AuthoredFile>}
97
+ */
98
+ async function loadAuthoredFile(docPath, lang) {
99
+ const file = path.basename(docPath);
100
+ let doc;
101
+ try {
102
+ const mod = await import(pathToFileURL(docPath).href);
103
+ doc = parseDoc(mod.docs ?? mod.default, file);
104
+ } catch (error) {
105
+ return {file, error};
106
+ }
107
+ if (!lang) return {file, doc};
108
+ const translationPath = overlayPath(docPath, lang);
109
+ if (!fs.existsSync(translationPath)) return {file, doc};
110
+ try {
111
+ const translationMod = await import(pathToFileURL(translationPath).href);
112
+ return {
113
+ file,
114
+ doc,
115
+ overlay: translationMod.docsZh || translationMod.docsDense || null,
116
+ };
117
+ } catch (overlayError) {
118
+ return {file, doc, overlayError};
119
+ }
120
+ }
121
+
122
+ /**
123
+ * Everything the compiler needs for one topic, read from disk.
124
+ * @param {import('../../foundation/discovery/docs-discovery.mjs').DocsTopicEntry} entry
125
+ * @param {string | null} lang
126
+ * @returns {Promise<import('../../foundation/doc-compiler/compile.mjs').ReferenceTopicInput>}
127
+ */
128
+ async function loadCompilerInput(entry, lang) {
129
+ const extensions = [];
130
+ for (const extension of entry.extensions) {
131
+ extensions.push({
132
+ ...(await loadAuthoredFile(extension.path, lang)),
133
+ provider: extension.package,
134
+ });
135
+ }
136
+ return {
137
+ id: entry.name,
138
+ provider: entry.package,
139
+ replaces: entry.replaces ?? null,
140
+ lang,
141
+ base: await loadAuthoredFile(entry.path, lang),
142
+ extensions,
143
+ };
144
+ }
145
+
146
+ /** @type {WeakMap<DocsCatalog, Map<string, Promise<import('../../foundation/doc-compiler/compile.mjs').CompiledReferenceNode>>>} */
147
+ const loweredByCatalog = new WeakMap();
148
+
149
+ /**
150
+ * One topic, lowered for `lang`: overlaid, extensions merged, keys stamped.
151
+ * Memoized per catalog, so a read that references a topic twice loads it once.
152
+ * Every read of the catalog shares the memoized node, so it is frozen; the
153
+ * lenses hand readers copies.
154
+ * @param {DocsCatalog} catalog
155
+ * @param {import('../../foundation/discovery/docs-discovery.mjs').DocsTopicEntry} entry
156
+ * @param {string | null} [lang]
157
+ * @returns {Promise<import('../../foundation/doc-compiler/compile.mjs').CompiledReferenceNode>}
158
+ */
159
+ export function lowerTopic(catalog, entry, lang = null) {
160
+ const overlay = overlayLanguage(lang);
161
+ let cache = loweredByCatalog.get(catalog);
162
+ if (!cache) {
163
+ cache = new Map();
164
+ loweredByCatalog.set(catalog, cache);
165
+ }
166
+ const key = `${entry.name.toLowerCase()}\u0000${overlay ?? ''}`;
167
+ let lowered = cache.get(key);
168
+ if (!lowered) {
169
+ lowered = loadCompilerInput(entry, overlay).then(input =>
170
+ deepFreeze(lowerReferenceTopic(input)),
171
+ );
172
+ cache.set(key, lowered);
173
+ }
174
+ return lowered;
175
+ }
176
+
177
+ /**
178
+ * Freeze a value and everything in it.
179
+ * @template T
180
+ * @param {T} value
181
+ * @returns {T}
182
+ */
183
+ function deepFreeze(value) {
184
+ if (value !== null && typeof value === 'object' && !Object.isFrozen(value)) {
185
+ Object.freeze(value);
186
+ for (const child of Object.values(value)) deepFreeze(child);
187
+ }
188
+ return value;
189
+ }
190
+
191
+ /**
192
+ * How a token reference finds its target: the topic it names in `catalog`,
193
+ * lowered for the same language.
194
+ * @param {DocsCatalog} catalog
195
+ * @param {string | null} lang
196
+ * @returns {(topic: string) => Promise<import('../../foundation/doc-compiler/compile.mjs').CompiledReferenceNode | null>}
197
+ */
198
+ export function referenceTargets(catalog, lang) {
199
+ return async topic => {
200
+ const target = catalog.resolve(topic);
201
+ return target ? lowerTopic(catalog, target, lang) : null;
202
+ };
203
+ }
204
+
205
+ /**
206
+ * One topic, compiled for `lang`: lowered, then every token reference linked.
207
+ * @param {DocsCatalog} catalog
208
+ * @param {import('../../foundation/discovery/docs-discovery.mjs').DocsTopicEntry} entry
209
+ * @param {string | null} [lang]
210
+ * @returns {Promise<import('../../foundation/doc-compiler/compile.mjs').CompiledReferenceNode>}
211
+ */
212
+ export async function compileTopic(catalog, entry, lang = null) {
213
+ return linkReferenceTopic(
214
+ await lowerTopic(catalog, entry, lang),
215
+ referenceTargets(catalog, lang),
216
+ );
217
+ }
218
+
189
219
  /**
190
220
  * Resolve `topic` against the project's catalog (throwing `ERR_UNKNOWN_TOPIC`
191
- * when unmatched), and load it with any --dense/--zh overlay and any
192
- * integration extension applied. Shared by the detail and section leaves so
193
- * topic normalization and unknown-topic handling live in exactly one place.
221
+ * when unmatched) and lower it with any --dense/--zh overlay and any
222
+ * integration extension applied. Shared by the leaves so topic normalization
223
+ * and unknown-topic handling live in exactly one place.
194
224
  *
195
225
  * @param {string} topic
196
226
  * @param {object} [options]
@@ -200,7 +230,7 @@ export function overlayLanguages(entry) {
200
230
  * @param {string} [options.cwd]
201
231
  * @returns {Promise<{
202
232
  * catalog: DocsCatalog,
203
- * docsData: import('./docs.type.mjs').DocsDetailResponse['data'],
233
+ * node: import('../../foundation/doc-compiler/compile.mjs').CompiledReferenceNode,
204
234
  * lang: string | null,
205
235
  * }>}
206
236
  */
@@ -221,6 +251,6 @@ export async function resolveTopicDocs(topic, options = {}) {
221
251
  );
222
252
  }
223
253
 
224
- const docsData = await loadTopicDoc(entry, {lang: effectiveLang});
225
- return {catalog, docsData, lang: effectiveLang};
254
+ const node = await lowerTopic(catalog, entry, effectiveLang);
255
+ return {catalog, node, lang: effectiveLang};
226
256
  }
@@ -0,0 +1,78 @@
1
+ // Copyright (c) Meta Platforms, Inc. and affiliates.
2
+
3
+ /**
4
+ * @file Every shipped topic compiles to a plain-JSON node that answers every
5
+ * docs read exactly as the live one does, and no read can change another read
6
+ * of the same catalog.
7
+ */
8
+
9
+ import {describe, expect, it} from 'vitest';
10
+ import {parseCompiledReferenceNode} from '../../foundation/doc-compiler/ir.mjs';
11
+ import {detailView, indexView} from '../../foundation/doc-compiler/lenses.mjs';
12
+ import {
13
+ compileTopic,
14
+ loadDocsCatalog,
15
+ lowerTopic,
16
+ overlayLanguages,
17
+ } from './_adapter.mjs';
18
+
19
+ const SLOW = 60_000;
20
+
21
+ describe('every shipped topic compiles to plain JSON', () => {
22
+ it(
23
+ 'survives a JSON round trip with identical responses in every language',
24
+ async () => {
25
+ const catalog = await loadDocsCatalog();
26
+ let compiled = 0;
27
+ for (const entry of catalog.entries()) {
28
+ for (const lang of [null, ...overlayLanguages(entry)]) {
29
+ const lowered = await lowerTopic(catalog, entry, lang);
30
+ expect(parseCompiledReferenceNode(lowered)).toBe(lowered);
31
+ const node = await compileTopic(catalog, entry, lang);
32
+ expect(parseCompiledReferenceNode(node)).toBe(node);
33
+ const copy = parseCompiledReferenceNode(
34
+ JSON.parse(JSON.stringify(node)),
35
+ );
36
+ expect(JSON.stringify(detailView(copy))).toBe(
37
+ JSON.stringify(detailView(node)),
38
+ );
39
+ expect(JSON.stringify(indexView(copy))).toBe(
40
+ JSON.stringify(indexView(node)),
41
+ );
42
+ compiled += 1;
43
+ }
44
+ }
45
+ expect(compiled).toBeGreaterThan(catalog.entries().length);
46
+ },
47
+ SLOW,
48
+ );
49
+ });
50
+
51
+ describe('reads that share a catalog', () => {
52
+ it(
53
+ 'never let one read change another',
54
+ async () => {
55
+ const catalog = await loadDocsCatalog();
56
+ const tokens = catalog.resolve('tokens');
57
+ const first = detailView(await compileTopic(catalog, tokens));
58
+ for (const section of first.sections) {
59
+ section.title = 'EDITED';
60
+ for (const block of section.content) {
61
+ if (typeof block.text === 'string') block.text = 'EDITED';
62
+ if (Array.isArray(block.rows)) block.rows.push(['EDITED']);
63
+ }
64
+ }
65
+ const again = detailView(await compileTopic(catalog, tokens));
66
+ const index = indexView(await lowerTopic(catalog, tokens));
67
+ const spacing = detailView(
68
+ await compileTopic(catalog, catalog.resolve('spacing')),
69
+ );
70
+ for (const read of [again, index, spacing]) {
71
+ expect(JSON.stringify(read)).not.toContain('EDITED');
72
+ }
73
+ const lowered = await lowerTopic(catalog, tokens);
74
+ expect(Object.isFrozen(lowered.doc.sections[0].content)).toBe(true);
75
+ },
76
+ SLOW,
77
+ );
78
+ });
@@ -1,21 +1,6 @@
1
1
  // @generated by scripts/sync-api-types.mjs from the JSDoc in api/**/*.mjs.
2
2
  // DO NOT EDIT — run `pnpm sync:api-types` to regenerate.
3
3
 
4
- /**
5
- * Resolve token-ref blocks by inlining the referenced section's table.
6
- * This allows section docs to reference token tables without duplicating data.
7
- *
8
- * The reference is resolved through the catalog, so a topic may point at one
9
- * an integration contributed (or replaced) rather than only at a built-in. It
10
- * names the section by key or authored title, so it resolves in every language.
11
- * @param {import('../docs.type.mjs').DocsDetailResponse['data']} docsData
12
- * @param {import('../../../foundation/discovery/docs-discovery.mjs').DocsCatalog} catalog
13
- * @param {{lang?: string | null}} [options]
14
- * @returns {Promise<import('../docs.type.mjs').DocsDetailResponse['data']>}
15
- */
16
- export function resolveTokenRefs(docsData: import("../docs.type.mjs").DocsDetailResponse["data"], catalog: import("../../../foundation/discovery/docs-discovery.mjs").DocsCatalog, { lang }?: {
17
- lang?: string | null;
18
- }): Promise<import("../docs.type.mjs").DocsDetailResponse["data"]>;
19
4
  /**
20
5
  * @param {string} topic
21
6
  * @param {object} [options]
@@ -3,84 +3,17 @@
3
3
  /**
4
4
  * @file docs.detail leaf — load one topic's full reference doc.
5
5
  *
6
- * @input A topic name plus optional {lang, zh, dense}. Resolves and loads the
7
- * topic via the shared adapter, then inlines any token-ref blocks.
6
+ * @input A topic name plus optional {lang, zh, dense, cwd}. Resolves the topic
7
+ * via the shared adapter and compiles it with its token references linked.
8
8
  * @output { type: 'docs.detail', data: ReferenceDoc } — the full doc with
9
- * token-refs resolved, matching `xds --json docs <topic>`.
10
- * @position Leaf under api/docs. Owns resolveTokenRefs (used only here); shares
11
- * discovery/loading/topic-resolution with the section leaf via _adapter.mjs.
9
+ * token-refs inlined, matching `astryx --json docs <topic>`.
10
+ * @position Leaf under api/docs. Reads the compiled node through the detail
11
+ * lens; resolution, overlays and extensions happen in the compiler.
12
12
  */
13
13
 
14
- import {loadTopicDoc, resolveTopicDocs} from '../_adapter.mjs';
15
- import {
16
- sectionKey,
17
- sourceTitle,
18
- withSourceTitle,
19
- } from '../../../foundation/discovery/docs-section-key.mjs';
20
-
21
- /**
22
- * Resolve token-ref blocks by inlining the referenced section's table.
23
- * This allows section docs to reference token tables without duplicating data.
24
- *
25
- * The reference is resolved through the catalog, so a topic may point at one
26
- * an integration contributed (or replaced) rather than only at a built-in. It
27
- * names the section by key or authored title, so it resolves in every language.
28
- * @param {import('../docs.type.mjs').DocsDetailResponse['data']} docsData
29
- * @param {import('../../../foundation/discovery/docs-discovery.mjs').DocsCatalog} catalog
30
- * @param {{lang?: string | null}} [options]
31
- * @returns {Promise<import('../docs.type.mjs').DocsDetailResponse['data']>}
32
- */
33
- export async function resolveTokenRefs(docsData, catalog, {lang = null} = {}) {
34
- const resolved = {...docsData, sections: [...docsData.sections]};
35
- for (let si = 0; si < resolved.sections.length; si++) {
36
- const section = resolved.sections[si];
37
- /** @type {import('@astryxdesign/cli/authoring').ReferenceContentBlock[]} */
38
- const newContent = [];
39
- for (const block of section.content) {
40
- if (block.type === 'token-ref') {
41
- const refEntry = catalog.resolve(block.topic);
42
- if (!refEntry) {
43
- newContent.push({type: 'prose', text: `[token-ref: unknown topic "${block.topic}"]`});
44
- continue;
45
- }
46
- const refDocs = await loadTopicDoc(refEntry, {lang});
47
- const wanted = block.section.toLowerCase();
48
- const refSection = refDocs.sections.find(
49
- (/** @type {import('@astryxdesign/cli/authoring').ReferenceSection} */ s) =>
50
- sectionKey(s) === block.section ||
51
- sourceTitle(s).toLowerCase() === wanted,
52
- );
53
- if (!refSection) {
54
- newContent.push({type: 'prose', text: `[token-ref: section "${block.section}" not found in "${block.topic}"]`});
55
- continue;
56
- }
57
- // Inline the referenced section's content blocks (tables, prose, etc.)
58
- // and carry over the previewType
59
- for (const refBlock of refSection.content) {
60
- newContent.push(refBlock);
61
- }
62
- // If the referenced section has a previewType, attach it to our section
63
- if (refSection.previewType && !section.previewType) {
64
- resolved.sections[si] = withSourceTitle(
65
- {...section, previewType: refSection.previewType, content: newContent},
66
- sourceTitle(section),
67
- );
68
- }
69
- } else {
70
- newContent.push(block);
71
- }
72
- }
73
- if (resolved.sections[si] === section) {
74
- resolved.sections[si] = withSourceTitle(
75
- {...section, content: newContent},
76
- sourceTitle(section),
77
- );
78
- } else {
79
- resolved.sections[si].content = newContent;
80
- }
81
- }
82
- return resolved;
83
- }
14
+ import {linkReferenceTopic} from '../../../foundation/doc-compiler/compile.mjs';
15
+ import {detailView} from '../../../foundation/doc-compiler/lenses.mjs';
16
+ import {referenceTargets, resolveTopicDocs} from '../_adapter.mjs';
84
17
 
85
18
  /**
86
19
  * @param {string} topic
@@ -92,7 +25,10 @@ export async function resolveTokenRefs(docsData, catalog, {lang = null} = {}) {
92
25
  * @returns {Promise<import('../docs.type.mjs').DocsDetailResponse>}
93
26
  */
94
27
  export async function detail(topic, options = {}) {
95
- const {catalog, docsData, lang} = await resolveTopicDocs(topic, options);
96
- const resolved = await resolveTokenRefs(docsData, catalog, {lang});
97
- return {type: 'docs.detail', data: resolved};
28
+ const {catalog, node, lang} = await resolveTopicDocs(topic, options);
29
+ const linked = await linkReferenceTopic(
30
+ node,
31
+ referenceTargets(catalog, lang),
32
+ );
33
+ return {type: 'docs.detail', data: detailView(linked)};
98
34
  }