@pretextbook/web-editor 0.5.2 → 0.5.4

package/dist/sectionUtils.d.ts

@@ -187,11 +187,30 @@ export declare function parseDivisionRefs(content: string): string[];
  * Like {@link parseDivisionRefs} but also returns the division type inferred
  * from the tag name (e.g. `<plus:chapter ref="x"/>` → `{ type: "chapter", xmlId: "x" }`).
  * Used to auto-create Division records when new refs appear in edited content.
+ *
+ * Only tag names in {@link DIVISION_REF_TAGS} are considered — asset
+ * placeholders (`plus:image`, `plus:doenet`, ...) are not divisions and are
+ * skipped. The generic `<plus:division ref="x"/>` alias falls back to type
+ * `"section"`, matching {@link tagToType}'s default for unrecognised tags.
  */
 export declare function parseDivisionRefsWithTypes(content: string): {
     xmlId: string;
     type: DivisionType;
 }[];
+/** A `<plus:image ref="..."/>` / `<plus:doenet ref="..."/>` asset placeholder. */
+export interface AssetRef {
+    kind: "image" | "doenet";
+    ref: string;
+}
+/**
+ * Parse every `<plus:image ref="..."/>` / `<plus:doenet ref="..."/>` asset
+ * placeholder out of `content`, in document order, without de-duplicating.
+ *
+ * Asset placeholders share the `<plus:* ref="..."/>` shape used by division
+ * refs (see {@link DIVISION_REF_TAGS}) but are deliberately parsed by a
+ * separate, disjoint tag set so the two kinds of include are never conflated.
+ */
+export declare function parseAssetRefs(content: string): AssetRef[];
 /**
  * Create a minimal Division record for a given `xmlId` and `type`.
  * Used when the user types a new `<plus:TYPE ref="id"/>` placeholder into a
@@ -297,17 +316,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