@peisar/peisar-wasm32-wasi 0.3.0 → 0.3.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@peisar/peisar-wasm32-wasi",
-  "version": "0.3.0",
+  "version": "0.3.01",
   "main": "peisar.wasi.cjs",
   "files": [
     "peisar.wasm32-wasi.wasm",

package/peisar.wasi-browser.js

@@ -1442,6 +1442,5 @@ try {
 export default __napiModule.exports
 export const Peisar = __napiModule.exports.Peisar
 export const PeisarCache = __napiModule.exports.PeisarCache
-export const EmphasisLevel = __napiModule.exports.EmphasisLevel
-export const TableCellAlignment = __napiModule.exports.TableCellAlignment
-export const TaskState = __napiModule.exports.TaskState
+export const frontmatter = __napiModule.exports.frontmatter
+export const yamlParser = __napiModule.exports.yamlParser

package/peisar.wasi.cjs

@@ -1,4 +1,4 @@
-// napi-rs-artifact-metadata:{"version":2,"rootEntry":"index.js","exports":["Peisar","PeisarCache","EmphasisLevel","TableCellAlignment","TaskState"],"managedRootEntries":["browser.js","index.js","peisar.wasm","peisar.debug.wasm"]}
+// napi-rs-artifact-metadata:{"version":2,"rootEntry":"index.cjs","exports":["Peisar","PeisarCache","frontmatter","yamlParser"],"managedRootEntries":["browser.js","index.cjs","peisar.wasm","peisar.debug.wasm"]}
 /* eslint-disable */
 /* auto-generated by NAPI-RS */
 
@@ -2299,6 +2299,5 @@ try {
 module.exports = __napiModule.exports
 module.exports.Peisar = __napiModule.exports.Peisar
 module.exports.PeisarCache = __napiModule.exports.PeisarCache
-module.exports.EmphasisLevel = __napiModule.exports.EmphasisLevel
-module.exports.TableCellAlignment = __napiModule.exports.TableCellAlignment
-module.exports.TaskState = __napiModule.exports.TaskState
+module.exports.frontmatter = __napiModule.exports.frontmatter
+module.exports.yamlParser = __napiModule.exports.yamlParser

package/peisar.wasi.d.cts

@@ -1,5 +1,7 @@
-/* auto-generated by NAPI-RS */
-/* eslint-disable */
+export type PeisarEmphasisLevel = "Italic" | "Bold";
+export type PeisarTableCellAlignment = "Default" | "Left" | "Center" | "Right";
+export type PeisarTableCellAlignments = PeisarTableCellAlignment[];
+export type PeisarTaskState = "Unchecked" | "Checked";
 
 /** The WASI flavor this loader instantiates. */
 export declare const __napiBindingTarget: 'wasm32-wasi'
@@ -66,8 +68,16 @@ export declare class Peisar {
 }
 
 /**
- * In-memory cache of markdown files under a given directory.
- * The cache maps absolute PathBuf -> raw file contents.
+ * In-memory cache of the Markdown and asset files under a directory tree.
+ *
+ * The cache maps absolute source paths to [`CachedContent`] entries, is
+ * mirrored to a `.peisar_cache` directory on disk, and — after
+ * [`PeisarCache::start_watching`] — tracks the source directories with a
+ * recursive file watcher.
+ *
+ * Rust consumers read the cache with [`PeisarCache::get`] and
+ * [`PeisarCache::all`]; JavaScript consumers use the N-API methods below
+ * (`getText`, `getBinary`, `listFiles`, `markdownFiles`, `assetFiles`, …).
  */
 export declare class PeisarCache {
   /**
@@ -82,14 +92,8 @@ export declare class PeisarCache {
    */
   static withConfigJs(entryDir: string, assetsDir?: string | undefined | null): PeisarCache
   /**
-   * Start watching the entry_dir recursively. The watcher will update the
-   * in-memory cache on create/modify/remove events for markdown files and
-   * assets, and persist updates to disk.
-   *
-   * The returned Result is only for watcher setup errors; runtime errors are
-   * printed to stderr by the watch callback.
-   *
-   * JS: `cache.startWatchingJs()` — errors surface as JS exceptions.
+   * JS: `cache.startWatchingJs()` — start watching the entry (and
+   * assets) directories recursively; errors surface as JS exceptions.
    */
   startWatchingJs(): void
   /**
@@ -123,6 +127,9 @@ export declare class PeisarCache {
   /**
    * JS: `cache.dispose()` — stop the watcher and drop JS change callbacks.
    * Safe to call more than once.
+   *
+   * Rust consumers do not need this: dropping the [`PeisarCache`] stops
+   * the watcher, closes the persistence channel, and joins the worker.
    */
   dispose(): void
 }
@@ -211,13 +218,13 @@ export type Block =
  * Synchronous block-visitor callback. Receives a `Block`, returns
  * `VisitControlJs` (or `undefined` for no changes).
  */
-export type BlockCallback = (arg: [Block]) => VisitControlJs | null
+export type BlockCallback = (arg: [Block]) => VisitorControl | null
 
 /**
  * Synchronous block parser hook. Receives a [`BlockParseContext`], returns
  * a [`BlockParseResultJs`] (or `undefined` to decline).
  */
-export type BlockParseCallback = (arg: [BlockParseContext]) => BlockParseResultJs | null
+export type BlockParseCallback = (arg: [BlockParseContext]) => BlockParseResult | null
 
 /**
  * Context passed to block parser hooks.
@@ -240,14 +247,17 @@ export interface BlockParseContext {
  * All fields are optional; omitting `block` (or returning `undefined`)
  * declines the position so the next hook / built-in parser handles it.
  */
-export interface BlockParseResultJs {
+export interface BlockParseResult {
   /** The parsed block node. */
   block?: Block
   /** Number of source lines consumed (must be at least `1`). */
   consumed?: number
 }
 
-/** A file-change event delivered to JavaScript `onChange` callbacks. */
+/**
+ * A file-change event delivered to change callbacks
+ * (see [`PeisarCache::on_change`]).
+ */
 export interface CacheChangeEvent {
   /** Absolute path of the changed file. */
   path: string
@@ -258,9 +268,9 @@ export interface CacheChangeEvent {
 }
 
 /**
- * An entry stored in the cache: raw UTF-8 text (markdown) or raw bytes
- * (binary assets).  Exposed to JavaScript so JS consumers can branch on
- * the variant.
+ * An entry stored in the cache: raw UTF-8 text (markdown and textual
+ * assets) or raw bytes (binary assets). Exposed to JavaScript so JS
+ * consumers can branch on the variant.
  */
 export type CachedContent =
   | { type: 'Text'; field0: string }
@@ -285,12 +295,14 @@ export interface Document {
   linkReferences: Array<LinkReferenceDefinition>
 }
 
-/** Emphasis strength. */
-export declare const enum EmphasisLevel {
-  /** `*italic*` / `_italic_` */
-  Italic = 0,
-  /** `**bold**` / `__bold__` */
-  Bold = 1,
+export declare function frontmatter(content: string): FrontmatterResult
+
+/** The Markdown body and YAML metadata parsed from a front-matter document. */
+export interface FrontmatterResult {
+  /** Markdown source after the leading YAML front matter is removed. */
+  pureMarkdownContent: string
+  /** Deserialized YAML front matter, or `null` when no front matter exists. */
+  yamlData?: Record<string, any>
 }
 
 /** Inline-level nodes. */
@@ -299,7 +311,7 @@ export type Inline =
     value: string; /** Source span. */
   pos: Span }
   | { type: 'Emphasis'; /** Emphasis level (italic or bold). */
-    level: EmphasisLevel; /** Nested inline content. */
+    level: PeisarEmphasisLevel; /** Nested inline content. */
     children: Array<Inline>; /** Source span. */
   pos: Span }
   | { type: 'Code'; /** The code text. */
@@ -337,13 +349,13 @@ export type Inline =
  * Synchronous inline-visitor callback. Receives an `Inline`, returns
  * `InlineVisitControlJs` (or `undefined` for no changes).
  */
-export type InlineCallback = (arg: [Inline]) => InlineVisitControlJs | null
+export type InlineCallback = (arg: [Inline]) => InlineVisitorControl | null
 
 /**
  * Synchronous inline parser hook. Receives an [`InlineParseContext`],
  * returns an [`InlineParseResultJs`] (or `undefined` to decline).
  */
-export type InlineParseCallback = (arg: [InlineParseContext]) => InlineParseResultJs | null
+export type InlineParseCallback = (arg: [InlineParseContext]) => InlineParseResult | null
 
 /**
  * Context passed to inline parser hooks.
@@ -363,7 +375,7 @@ export interface InlineParseContext {
  * All fields are optional; omitting `inline` (or returning `undefined`)
  * declines the position so the next hook / built-in parser handles it.
  */
-export interface InlineParseResultJs {
+export interface InlineParseResult {
   /** The parsed inline node. */
   inline?: Inline
   /** Number of characters consumed (`0` or missing declines). */
@@ -376,7 +388,7 @@ export interface InlineParseResultJs {
  * Returned from the JS `visitInline` callback.  All fields are optional;
  * omitting a field means "no change" for that operation.
  */
-export interface InlineVisitControlJs {
+export interface InlineVisitorControl {
   /** Nodes to insert before the current node. */
   insertBefore?: Array<Inline>
   /** Nodes to insert after the current node. */
@@ -406,39 +418,12 @@ export interface ListItem {
   /** Nested block content of the item. */
   children: Array<Block>
   /** GFM task-list state: `None` = not a task, `Some` = checked / unchecked. */
-  task?: TaskState
+  task?: PeisarTaskState
   /** Span of the item in the *sub-document* of its enclosing list. */
   pos: Span
 }
 
-/**
- * JavaScript object shape for a parser hook pair.
- *
- * ```js
- * const myParser = {
- *   parseBlock(ctx) {
- *     if (!ctx.line.startsWith(':::')) return;         // decline
- *     const name = ctx.line.slice(3).trim();
- *     return {
- *       block: { type: 'HtmlBlock', html: `<div data-name="${name}"></div>`, pos: { start: {}, end: {} } },
- *       consumed: 1,
- *     };
- *   },
- *   parseInline(ctx) {
- *     if (!ctx.rest.startsWith('@@')) return;          // decline
- *     const end = ctx.rest.indexOf(' ', 2);
- *     const name = end === -1 ? ctx.rest.slice(2) : ctx.rest.slice(2, end);
- *     return {
- *       inline: { type: 'HtmlInline', html: `<span data-name="${name}"></span>`, pos: { start: {}, end: {} } },
- *       consumed: name.length + 2,
- *     };
- *   },
- * };
- * document.useParser(myParser);
- * ```
- *
- * Either property may be omitted / `null` to skip that phase.
- */
+/** Either property may be omitted / `null` to skip that phase. */
 export interface Parser {
   /** Optional JS block parser hook (JS: `parseBlock`). */
   parseBlock?: BlockParseCallback
@@ -446,14 +431,6 @@ export interface Parser {
   parseInline?: InlineParseCallback
 }
 
-/** The Markdown body and YAML metadata parsed from a front-matter document. */
-export interface ParseResult {
-  /** Markdown source after the leading YAML front matter is removed. */
-  pureMarkdownContent: string
-  /** Deserialized YAML front matter, or `null` when no front matter exists. */
-  yamlData?: Record<string, any>
-}
-
 /**
  * JavaScript options for Markdown parsing and HTML rendering.
  *
@@ -588,7 +565,7 @@ export interface Table {
   /** Body rows. */
   rows: Array<TableRow>
   /** Column alignment specifications (one per column). */
-  alignments: Array<TableCellAlignment>
+  alignments: PeisarTableCellAlignments
 }
 
 /** A single table cell. */
@@ -597,30 +574,33 @@ export interface TableCell {
   children: Array<Inline>
 }
 
-/** Column alignment for table cells. */
-export declare const enum TableCellAlignment {
-  /** `:---` or `---` — default (left) */
-  Default = 0,
-  /** `:---` */
-  Left = 1,
-  /** `:---:` */
-  Center = 2,
-  /** `---:` */
-  Right = 3,
-}
-
 /** A single table row (header or body). */
 export interface TableRow {
   /** The cells in this row. */
   cells: Array<TableCell>
 }
 
-/** GFM task-list checkbox state. */
-export declare const enum TaskState {
-  /** `[ ]` — unchecked */
-  Unchecked = 0,
-  /** `[x]` / `[X]` — checked */
-  Checked = 1,
+/**
+ * JavaScript object shape for a visitor callback pair.
+ *
+ * On the JS side it is a plain object with two optional
+ * function properties:
+ *
+ * ```js
+ * const myPlugin = {
+ *   visitBlock(block)  { return { recurse: true }; },
+ *   visitInline(inline) { return {}; },
+ * };
+ * ast.addVisitor(myPlugin);
+ * ```
+ *
+ * Either property may be omitted / `null` to skip that node kind.
+ */
+export interface Visitor {
+  /** Optional JS callback for block nodes (JS: `visitBlock`). */
+  visitBlock?: BlockCallback
+  /** Optional JS callback for inline nodes (JS: `visitInline`). */
+  visitInline?: InlineCallback
 }
 
 /**
@@ -629,7 +609,7 @@ export declare const enum TaskState {
  * Returned from the JS `visitBlock` callback.  All fields are optional;
  * omitting a field means "no change" for that operation.
  */
-export interface VisitControlJs {
+export interface VisitorControl {
   /** Nodes to insert before the current node. */
   insertBefore?: Array<Block>
   /** Nodes to insert after the current node. */
@@ -643,24 +623,13 @@ export interface VisitControlJs {
 }
 
 /**
- * JavaScript object shape for a visitor callback pair.
+ * Parses a YAML document into a JSON-compatible value.
  *
- * On the JS side it is a plain object with two optional
- * function properties:
+ * When consumed from Node.js, the result is exposed as a JavaScript object
+ * with the TypeScript type `Record<string, any>`.
  *
- * ```js
- * const myPlugin = {
- *   visitBlock(block)  { return { recurse: true }; },
- *   visitInline(inline) { return {}; },
- * };
- * ast.addVisitor(myPlugin);
- * ```
+ * # Panics
  *
- * Either property may be omitted / `null` to skip that node kind.
+ * Panics when `yaml_str` is not valid YAML.
  */
-export interface Visitor {
-  /** Optional JS callback for block nodes (JS: `visitBlock`). */
-  visitBlock?: BlockCallback
-  /** Optional JS callback for inline nodes (JS: `visitInline`). */
-  visitInline?: InlineCallback
-}
+export declare function yamlParser(yamlStr: string): Record<string, any>