@pretextbook/remark-pretext 0.0.4 → 0.0.6

package/dist/lib/context.d.ts

@@ -1,4 +1,5 @@
 import { BlockContent, DefinitionContent, PhrasingContent } from 'mdast';
+import { DivisionType } from '@pretextbook/ptxast';
 export interface VisitContext {
     /** Parent node, if any. */
     parent?: BlockContent | DefinitionContent | PhrasingContent;
@@ -10,6 +11,8 @@ export interface VisitContext {
     messages?: ConversionMessage[];
     /** Raw source markdown (optional, used for delimiter detection). */
     source?: string;
+    /** The division type that a depth-1 heading (`#`) maps to. */
+    topLevelDivision: DivisionType;
 }
 export interface ConversionMessage {
     type: 'warning' | 'error';

package/dist/lib/frontmatter.d.ts

@@ -0,0 +1,8 @@
+import { DivisionType } from '@pretextbook/ptxast';
+export interface FrontmatterResult {
+    /** The declared top-level division type, if present and valid. */
+    division?: DivisionType;
+    /** The markdown source with the frontmatter block removed. */
+    body: string;
+}
+export declare function extractFrontmatter(markdown: string): FrontmatterResult;

package/dist/lib/markdown-to-pretext.d.ts

@@ -1,3 +1,4 @@
+import { RemarkPretextOptions } from './remark-pretext.js';
 /**
  * Convert a markdown string (with PreTeXt directive extensions) to a PreTeXt
  * XML string.
@@ -6,6 +7,7 @@
  * node serialized as a string — suitable for embedding in a PreTeXt document.
  *
  * @param markdown - The markdown source to convert.
+ * @param options - Conversion options, e.g. `topLevelDivision`.
  * @returns A PreTeXt XML string.
  *
  * @example
@@ -16,4 +18,4 @@
  * // → '<section>\n  <title>Hello</title>\n  <p>This is a paragraph.</p>\n</section>'
  * ```
  */
-export declare function markdownToPretext(markdown: string): string;
+export declare function markdownToPretext(markdown: string, options?: RemarkPretextOptions): string;

package/dist/lib/mdast-to-ptxast.d.ts

@@ -1,13 +1,19 @@
 import { Root as MdastRoot } from 'mdast';
 import { Root } from 'xast';
 import { ConversionMessage } from './context.js';
+import { DivisionType } from '@pretextbook/ptxast';
 /** Result type for conversion: tree + diagnostic messages. */
 export interface ConversionResult {
     tree: Root;
     messages: ConversionMessage[];
 }
+/** Options controlling heading-to-division conversion. */
+export interface MdastToPtxastOptions {
+    /** The division type that a depth-1 heading (`#`) maps to. Defaults to `'chapter'`. */
+    topLevelDivision?: DivisionType;
+}
 /** Transform an mdast Root node into an xast Root node (backwards compatible). */
-export declare function mdastToPtxast(tree: MdastRoot, source?: string): Root;
+export declare function mdastToPtxast(tree: MdastRoot, source?: string, options?: MdastToPtxastOptions): Root;
 export { mdastToPtxast as mdastToXast };
 /** Transform an mdast Root node, returning tree + diagnostic messages. */
-export declare function mdastToPtxastWithDiagnostics(tree: MdastRoot, source?: string): ConversionResult;
+export declare function mdastToPtxastWithDiagnostics(tree: MdastRoot, source?: string, options?: MdastToPtxastOptions): ConversionResult;

package/dist/lib/remark-pretext.d.ts

@@ -1,8 +1,15 @@
 import { Plugin } from 'unified';
 import { Root as MdastRoot } from 'mdast';
 import { Root } from 'xast';
-/** Options for the remark-pretext plugin (currently none, reserved for future use). */
+import { DivisionType } from '@pretextbook/ptxast';
+/** Options for the remark-pretext plugin. */
 export interface RemarkPretextOptions {
+    /**
+     * The division type that a depth-1 heading (`#`) maps to. Overrides any
+     * `division:` field declared in the markdown's frontmatter. Defaults to
+     * `'chapter'` (matching historical behavior) when neither is set.
+     */
+    topLevelDivision?: DivisionType;
 }
 declare const remarkPretext: Plugin<[RemarkPretextOptions?], MdastRoot, Root>;
 export default remarkPretext;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pretextbook/remark-pretext",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "description": "remark plugin to transform markdown-style PreTeXt directives into ptxast",
   "author": "Oscar Levin",
   "license": "MIT",
@@ -39,7 +39,7 @@
     "test": "vitest run"
   },
   "dependencies": {
-    "@pretextbook/ptxast": "^0.0.4",
+    "@pretextbook/ptxast": "^0.0.5",
     "@types/mdast": "^4.0.0",
     "mdast-util-directive": "^3.0.0",
     "remark-directive": "^4.0.0",