@origints/markdown 0.1.1 → 0.3.2

package/dist/markdown-node.d.ts

@@ -1,3 +1,4 @@
+import { TYPE_LABEL } from '@origints/core';
 import { Root, Content } from 'mdast';
 import { MarkdownResult, MarkdownPath, SourcePosition } from './markdown-result';
 import { HeadingData, CodeBlockData, InlineCodeData, LinkData, ImageData, ListData, TableData, BlockquoteData, ParagraphData, DefinitionData } from './typed-extractors';
@@ -18,6 +19,7 @@ export declare class MarkdownNode {
     private readonly node;
     private readonly _path;
     private readonly root;
+    get [TYPE_LABEL](): string;
     private constructor();
     /**
      * Creates a MarkdownNode from a parsed mdast tree.

package/dist/markdown-spec-builder.d.ts

@@ -0,0 +1,36 @@
+import { ExtractSpec, ArraySpec, Spec } from '@origints/core';
+import { MarkdownStep } from './markdown-spec';
+/**
+ * Spec builder for a Markdown node — navigation and extraction.
+ */
+export declare class MarkdownNodeSB {
+    private readonly steps;
+    /** @internal */
+    constructor(steps: readonly MarkdownStep[]);
+    /** Select a single node matching a CSS-like selector */
+    select(selector: string): MarkdownNodeSB;
+    /** Select the nth node matching a CSS-like selector */
+    selectAt(selector: string, index: number): MarkdownNodeSB;
+    /** Navigate to a child by index */
+    child(index: number): MarkdownNodeSB;
+    /** Navigate to the first child */
+    first(): MarkdownNodeSB;
+    /** Navigate to the last child */
+    last(): MarkdownNodeSB;
+    /** Extract text content */
+    text(): ExtractSpec<MarkdownStep, 'text'>;
+    /** Select all matching nodes, mapping each to a spec */
+    selectAll<T extends Spec>(selector: string, itemMapper: (node: MarkdownNodeSB) => T): ArraySpec<T>;
+    /** Iterate over direct children, mapping each to a spec */
+    children<T extends Spec>(itemMapper: (node: MarkdownNodeSB) => T): ArraySpec<T>;
+}
+/**
+ * Spec builder for Markdown — the entry point for Markdown navigation specs.
+ *
+ * Used as `$` in `emit()` after `.mapIn(parseMarkdown())`.
+ */
+export declare class MarkdownSpecBuilder extends MarkdownNodeSB {
+    private constructor();
+    /** Create a root spec builder */
+    static root(): MarkdownSpecBuilder;
+}

package/dist/markdown-spec-executor.d.ts

@@ -0,0 +1,6 @@
+import { ExtractionResult } from '@origints/core';
+import { MarkdownSpec } from './markdown-spec';
+/**
+ * Execute a MarkdownSpec against data (expected to be a MarkdownNode).
+ */
+export declare function executeMarkdownSpec(spec: MarkdownSpec, data: unknown): ExtractionResult<unknown>;

package/dist/markdown-spec.d.ts

@@ -0,0 +1,32 @@
+import { ExtractSpec } from '@origints/core';
+/**
+ * A single navigation step through a Markdown document.
+ */
+export type MarkdownStep = {
+    readonly kind: 'select';
+    readonly selector: string;
+} | {
+    readonly kind: 'selectAll';
+    readonly selector: string;
+    readonly index: number;
+} | {
+    readonly kind: 'child';
+    readonly index: number;
+} | {
+    readonly kind: 'first';
+} | {
+    readonly kind: 'last';
+};
+/**
+ * The terminal extraction type for a Markdown value.
+ */
+export type MarkdownExtract = 'text' | {
+    readonly kind: 'selectAll';
+    readonly selector: string;
+} | {
+    readonly kind: 'children';
+};
+/**
+ * A complete Markdown extraction spec.
+ */
+export type MarkdownSpec = ExtractSpec<MarkdownStep, MarkdownExtract>;

package/dist/parse.d.ts

@@ -1,4 +1,5 @@
-import { TransformAst, TransformImpl } from '@origints/core';
+import { TransformImpl, TypedTransformAst } from '@origints/core';
+import { MarkdownSpecBuilder } from './markdown-spec-builder';
 /**
  * Options for parsing Markdown.
  */
@@ -23,14 +24,17 @@ export interface MarkdownParseOptions {
  * Create a parseMarkdown transform AST.
  *
  * @example
- * ```typescript
- * const plan = Planner.in(loadFile('README.md'))
+ * ```ts
+ * const plan = new Planner()
+ *   .in(loadFile('README.md'))
  *   .mapIn(parseMarkdown())
- *   .inject((node) => node.select('heading[depth=1]').value.asHeading().value.text)
+ *   .emit((out, $) => out
+ *     .add('title', $.get('heading').string())
+ *   )
  *   .compile()
  * ```
  */
-export declare function parseMarkdown(options?: MarkdownParseOptions): TransformAst;
+export declare function parseMarkdown(options?: MarkdownParseOptions): TypedTransformAst<MarkdownSpecBuilder>;
 /**
  * Transform implementation for parseMarkdown.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@origints/markdown",
-  "version": "0.1.1",
+  "version": "0.3.2",
   "description": "Markdown parsing and manipulation for Origins with full lineage tracking",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -33,7 +33,7 @@
     "yaml": "^2.7.0"
   },
   "peerDependencies": {
-    "@origints/core": "^0.1.0"
+    "@origints/core": "^0.3.0"
   },
   "devDependencies": {
     "@origints/core": "workspace:*",
@@ -58,5 +58,19 @@
     "url": "https://github.com/fponticelli/origints.git",
     "directory": "packages/markdown"
   },
+  "homepage": "https://origints.dev",
+  "bugs": "https://github.com/fponticelli/origints/issues",
+  "keywords": [
+    "origints",
+    "data-extraction",
+    "lineage",
+    "provenance",
+    "markdown",
+    "gfm",
+    "frontmatter"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
   "license": "MIT"
 }