@pretextbook/web-editor 0.5.1 → 0.5.3

package/dist/sectionUtils.d.ts

@@ -297,17 +297,33 @@ export declare function buildDivisionTree(divisions: Division[], startXmlId: str
  */
 export declare function getOrphanRoots(divisions: Division[], rootXmlId: string): Division[];
 /**
- * Assemble the full PreTeXt source for a project by resolving the root
- * division and recursively expanding every `<plus:* ref="..."/>` placeholder
- * it (transitively) contains, converting any LaTeX/Markdown divisions to
- * PreTeXt along the way.
+ * Resolve the root division and recursively expand every
+ * `<plus:* ref="..."/>` placeholder it (transitively) contains, converting
+ * any LaTeX/Markdown divisions to PreTeXt along the way. Returns the bare
+ * root element (e.g. `<book>...</book>`) — *not* wrapped in `<pretext>` and
+ * without `<docinfo>`.
  *
- * This is what a host application sends to the build server (e.g.
- * `https://build.pretext.plus`) to produce the final rendered document — the
- * `divisions` pool itself is never a valid build input, since it's a flat
- * list of fragments rather than a single document tree.
+ * This is the body half of a full document. Most callers that want an
+ * actual buildable/persistable document should use
+ * {@link assembleFullProjectSource} instead; this lower-level function
+ * remains for callers (like the division-scoped preview path) that need to
+ * compose the resolved body further before wrapping it themselves.
  */
 export declare function assembleProjectSource(divisions: Division[], rootXmlId: string): string;
+/**
+ * Assemble the complete PreTeXt document for a project: the root division,
+ * fully resolved (every `<plus:* ref="..."/>` placeholder expanded and any
+ * LaTeX/Markdown divisions converted to PreTeXt), wrapped in the outer
+ * `<pretext>` element with `<docinfo>` inserted as its sibling.
+ *
+ * This is the same shape produced for a root-division preview build, and is
+ * what a host application should persist as "the full source" and send to a
+ * build server (e.g. `https://build.pretext.plus`) to produce the final
+ * rendered document — the `divisions` pool itself is never a valid build
+ * input, since it's a flat list of fragments rather than a single document
+ * tree.
+ */
+export declare function assembleFullProjectSource(divisions: Division[], rootXmlId: string, docinfo: string): string;
 /**
  * Wrap a single division's own tagged XML (e.g.
  * `<section xml:id="...">...</section>`) into a standalone PreTeXt fragment
@@ -329,7 +345,5 @@ export declare function assembleProjectSource(divisions: Division[], rootXmlId:
  * `docinfo` (the full `<docinfo>...</docinfo>` element, or `""`) is inserted
  * as a sibling of the root element inside `<pretext>`, matching real PreTeXt
  * document shape.
- *
- * We need to add `label="preview"` (or really any label) since if this isn't present the build server won't know what file to return.
  */
 export declare function wrapDivisionForPreview(divisionType: DivisionType, divisionXml: string, docinfo: string, wrapperTitle: string): string;