@ox-content/napi 3.0.0-alpha.13 → 3.0.0-alpha.15

package/index.d.ts

@@ -885,11 +885,35 @@ export interface JsEditThisPageOptions {
    */
   branch?: string
   /**
-   * Root directory used to relativize `sourcePath`.
+   * Where the source root sits inside the repository. Prefixed to the
+   * page path, which is then taken relative to `src_dir`.
    *
-   * Default: no extra root prefix.
+   * Default: no prefix, and the page path stays relative to the process's
+   * working directory.
    */
   rootDir?: string
+  /**
+   * Absolute path of the source root on disk, supplied by the build so
+   * `root_dir` can be joined with the page's path inside that root.
+   *
+   * Default: none, which makes `root_dir` inert.
+   */
+  srcDir?: string
+  /**
+   * Forge whose edit-URL shape to use: `github`, `gitlab`, `bitbucket`,
+   * or `gitea`.
+   *
+   * Default: inferred from the `repo_url` host, falling back to
+   * `github`. An unrecognized value is inferred the same way.
+   */
+  provider?: string
+  /**
+   * Edit-URL template, which wins over `provider`. Understands
+   * `{repoUrl}`, `{branch}`, and `{path}`; other braces stay literal.
+   *
+   * Default: the pattern for the resolved provider.
+   */
+  urlPattern?: string
   /**
    * Link label.
    *
@@ -1507,6 +1531,16 @@ export interface JsMathOptions {
   enabled?: boolean
 }
 
+/** A parsed document on its way to a JavaScript `transformers` hook. */
+export interface JsMdastTransformResult {
+  /** The tree, as mdast JSON. */
+  astJson: string
+  /** Frontmatter as JSON, which the tree has no room for. */
+  frontmatter: string
+  /** Preprocessing and parse errors collected so far. */
+  errors: Array<string>
+}
+
 /** Built-in media embed transform switches. */
 export interface JsMediaEmbedsOptions {
   /**
@@ -3165,7 +3199,13 @@ export declare function prepareSource(source: string, options?: JsSourceOptions
  */
 export declare function prepareSourceRaw(source: string, options?: JsSourceOptions | undefined | null): Uint8Array
 
-/** Renders an AST (provided as JSON) to HTML. */
+/**
+ * Renders an mdast (provided as JSON) to HTML.
+ *
+ * The counterpart to [`parse`]: a tree rewritten in JavaScript comes back
+ * through here and is rendered by the same renderer the original would
+ * have used.
+ */
 export declare function render(astJson: string): RenderResult
 
 /**
@@ -3241,6 +3281,26 @@ export declare function transformAsync(source: string, options?: JsTransformOpti
 /** Numbers headings, figures, and tables, and links `@id` references to them. */
 export declare function transformCrossReferences(html: string, options: JsCrossReferencesOptions): JsCrossReferenceOutput
 
+/**
+ * Finishes a transform from an mdast a JavaScript `transformers` hook may
+ * have rewritten.
+ *
+ * `transformMdastRaw` produces the tree; this renders it and runs
+ * everything that follows rendering — HTML postprocessing, sanitization,
+ * the table of contents, and the MDX metadata — so a rewritten tree loses
+ * none of it. `frontmatterJson` is carried through untouched.
+ */
+export declare function transformFromMdast(astJson: string, frontmatterJson: string, options?: JsTransformOptions | undefined | null): TransformResult
+
+/**
+ * Runs a transform up to the point where the tree exists.
+ *
+ * The counterpart to `transformFromMdast`: frontmatter is parsed and the
+ * opt-in Markdown features are expanded, then the tree is handed over as
+ * JSON for a `transformers` hook to rewrite.
+ */
+export declare function transformMdast(source: string, options?: JsTransformOptions | undefined | null): JsMdastTransformResult
+
 /**
  * Transforms Markdown into a raw mdast transfer buffer.
  *

package/index.js

@@ -171,6 +171,8 @@ module.exports.render = binding.render;
 module.exports.transform = binding.transform;
 module.exports.transformAsync = binding.transformAsync;
 module.exports.transformMdastRaw = binding.transformMdastRaw;
+module.exports.transformMdast = binding.transformMdast;
+module.exports.transformFromMdast = binding.transformFromMdast;
 module.exports.sanitizeHtml = binding.sanitizeHtml;
 module.exports.transformMediaEmbeds = binding.transformMediaEmbeds;
 module.exports.transformMediaEmbedsWithDiagnostics = binding.transformMediaEmbedsWithDiagnostics;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ox-content/napi",
-  "version": "3.0.0-alpha.13",
+  "version": "3.0.0-alpha.15",
   "description": "Node.js bindings for Ox Content - High-performance Markdown parser",
   "keywords": [
     "markdown",
@@ -47,12 +47,12 @@
     ]
   },
   "optionalDependencies": {
-    "@ox-content/binding-darwin-x64": "3.0.0-alpha.13",
-    "@ox-content/binding-darwin-arm64": "3.0.0-alpha.13",
-    "@ox-content/binding-linux-x64-gnu": "3.0.0-alpha.13",
-    "@ox-content/binding-linux-x64-musl": "3.0.0-alpha.13",
-    "@ox-content/binding-linux-arm64-gnu": "3.0.0-alpha.13",
-    "@ox-content/binding-linux-arm64-musl": "3.0.0-alpha.13",
-    "@ox-content/binding-win32-x64-msvc": "3.0.0-alpha.13"
+    "@ox-content/binding-darwin-x64": "3.0.0-alpha.15",
+    "@ox-content/binding-darwin-arm64": "3.0.0-alpha.15",
+    "@ox-content/binding-linux-x64-gnu": "3.0.0-alpha.15",
+    "@ox-content/binding-linux-x64-musl": "3.0.0-alpha.15",
+    "@ox-content/binding-linux-arm64-gnu": "3.0.0-alpha.15",
+    "@ox-content/binding-linux-arm64-musl": "3.0.0-alpha.15",
+    "@ox-content/binding-win32-x64-msvc": "3.0.0-alpha.15"
   }
 }