@isdk/mdast-plus 0.1.2 → 0.2.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@isdk/mdast-plus",
   "description": "A semantic-first Markdown processing toolkit based on unified, remark, and rehype with a Fluent API and staged plugin system.",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "license": "MIT",
   "author": "Riceball LEE <snowyu.lee@gmail.com>",
   "homepage": "https://github.com/isdk/mdast-plus.js",
@@ -22,30 +22,38 @@
     }
   },
   "dependencies": {
+    "@mozilla/readability": "^0.6.0",
     "ajv": "^8.17.1",
     "ajv-formats": "^3.0.1",
-    "lodash-es": "^4.17.22",
-    "mdast-util-to-hast": "^13.2.1",
+    "hast-util-from-dom": "^5.0.1",
+    "hast-util-from-html": "^2.0.3",
     "hast-util-to-mdast": "^10.1.2",
+    "lodash-es": "^4.17.22",
     "mdast-util-directive": "^3.1.0",
     "mdast-util-gfm": "^3.1.0",
     "mdast-util-math": "^3.0.0",
+    "mdast-util-to-hast": "^13.2.1",
+    "rehype-parse": "^9.0.1",
+    "rehype-remark": "^10.0.1",
+    "rehype-sanitize": "^6.0.0",
+    "rehype-stringify": "^10.0.1",
     "remark-directive": "^4.0.0",
     "remark-frontmatter": "^5.0.0",
     "remark-gfm": "^4.0.1",
     "remark-math": "^6.0.0",
     "remark-parse": "^11.0.0",
-    "remark-stringify": "^11.0.0",
-    "rehype-parse": "^9.0.1",
-    "rehype-stringify": "^10.0.1",
-    "rehype-remark": "^10.0.1",
     "remark-rehype": "^11.1.2",
-    "rehype-sanitize": "^6.0.0",
+    "remark-stringify": "^11.0.0",
     "shell-quote": "^1.8.3",
     "unified": "^11.0.5",
     "unist-util-select": "^5.1.0",
     "unist-util-visit": "^5.0.0",
-    "util-ex": "^2.4.0"
+    "util-ex": "^2.4.0",
+    "vfile": "^6.0.3",
+    "yaml": "^2.8.2"
+  },
+  "peerDependencies": {
+    "jsdom": "^27.3.0"
   },
   "devDependencies": {
     "@antfu/eslint-config": "^4.10.1",
@@ -61,6 +69,7 @@
     "eslint": "^9.34.0",
     "eslint-config-prettier": "^10.1.8",
     "eslint-plugin-tsdoc": "^0.4.0",
+    "jsdom": "^27.3.0",
     "json-schema-to-typescript": "^15.0.4",
     "prettier": "^3.6.2",
     "terser": "^5.44.0",

package/docs/classes/FluentProcessor.md

@@ -1,210 +0,0 @@
-[**@isdk/mdast-plus**](../README.md)
-
-***
-
-[@isdk/mdast-plus](../globals.md) / FluentProcessor
-
-# Class: FluentProcessor
-
-Defined in: [packages/mdast-plus/src/pipeline.ts:20](https://github.com/isdk/mdast-plus.js/blob/75ee549d3fb31ef4bc1b4a6b3307f6368072874e/src/pipeline.ts#L20)
-
-Fluent processor for mdast transformations.
-Allows chaining configuration and finally converting to a target format.
-
-## Constructors
-
-### Constructor
-
-> **new FluentProcessor**(`input`): `FluentProcessor`
-
-Defined in: [packages/mdast-plus/src/pipeline.ts:54](https://github.com/isdk/mdast-plus.js/blob/75ee549d3fb31ef4bc1b4a6b3307f6368072874e/src/pipeline.ts#L54)
-
-Creates a new FluentProcessor instance.
-
-#### Parameters
-
-##### input
-
-`any`
-
-The input content (string or mdast tree)
-
-#### Returns
-
-`FluentProcessor`
-
-## Properties
-
-### formats
-
-> `static` **formats**: `Record`\<`string`, [`MdastFormatDefinition`](../interfaces/MdastFormatDefinition.md)\>
-
-Defined in: [packages/mdast-plus/src/pipeline.ts:22](https://github.com/isdk/mdast-plus.js/blob/75ee549d3fb31ef4bc1b4a6b3307f6368072874e/src/pipeline.ts#L22)
-
-Map of registered format definitions
-
-## Methods
-
-### data()
-
-> **data**(`data`): `this`
-
-Defined in: [packages/mdast-plus/src/pipeline.ts:88](https://github.com/isdk/mdast-plus.js/blob/75ee549d3fb31ef4bc1b4a6b3307f6368072874e/src/pipeline.ts#L88)
-
-Merges global data into the processor.
-
-#### Parameters
-
-##### data
-
-`Record`\<`string`, `any`\>
-
-Key-value pairs to store in global data
-
-#### Returns
-
-`this`
-
-***
-
-### from()
-
-> **from**(`format`): `this`
-
-Defined in: [packages/mdast-plus/src/pipeline.ts:70](https://github.com/isdk/mdast-plus.js/blob/75ee549d3fb31ef4bc1b4a6b3307f6368072874e/src/pipeline.ts#L70)
-
-Specifies the input format.
-
-#### Parameters
-
-##### format
-
-`string`
-
-The input format name (default: 'markdown')
-
-#### Returns
-
-`this`
-
-***
-
-### to()
-
-> **to**(`format`): `Promise`\<[`ConvertResult`](../interfaces/ConvertResult.md)\<`string`\>\>
-
-Defined in: [packages/mdast-plus/src/pipeline.ts:98](https://github.com/isdk/mdast-plus.js/blob/75ee549d3fb31ef4bc1b4a6b3307f6368072874e/src/pipeline.ts#L98)
-
-Converts the input content to the specified format.
-
-#### Parameters
-
-##### format
-
-`string`
-
-The output format name
-
-#### Returns
-
-`Promise`\<[`ConvertResult`](../interfaces/ConvertResult.md)\<`string`\>\>
-
-A promise resolving to the conversion result (content and assets)
-
-***
-
-### toAST()
-
-> **toAST**(): `Promise`\<`Root`\>
-
-Defined in: [packages/mdast-plus/src/pipeline.ts:180](https://github.com/isdk/mdast-plus.js/blob/75ee549d3fb31ef4bc1b4a6b3307f6368072874e/src/pipeline.ts#L180)
-
-Helper to get the processed mdast tree.
-
-#### Returns
-
-`Promise`\<`Root`\>
-
-A promise resolving to the mdast Root node
-
-***
-
-### toHTML()
-
-> **toHTML**(): `Promise`\<`string`\>
-
-Defined in: [packages/mdast-plus/src/pipeline.ts:171](https://github.com/isdk/mdast-plus.js/blob/75ee549d3fb31ef4bc1b4a6b3307f6368072874e/src/pipeline.ts#L171)
-
-Helper to convert content to HTML.
-
-#### Returns
-
-`Promise`\<`string`\>
-
-A promise resolving to the HTML string
-
-***
-
-### toMarkdown()
-
-> **toMarkdown**(): `Promise`\<`string`\>
-
-Defined in: [packages/mdast-plus/src/pipeline.ts:162](https://github.com/isdk/mdast-plus.js/blob/75ee549d3fb31ef4bc1b4a6b3307f6368072874e/src/pipeline.ts#L162)
-
-Helper to convert content to Markdown.
-
-#### Returns
-
-`Promise`\<`string`\>
-
-A promise resolving to the Markdown string
-
-***
-
-### use()
-
-> **use**(`plugin`): `this`
-
-Defined in: [packages/mdast-plus/src/pipeline.ts:79](https://github.com/isdk/mdast-plus.js/blob/75ee549d3fb31ef4bc1b4a6b3307f6368072874e/src/pipeline.ts#L79)
-
-Adds a plugin to the processing pipeline.
-
-#### Parameters
-
-##### plugin
-
-[`MdastPlugin`](../interfaces/MdastPlugin.md)
-
-The mdast plugin to use
-
-#### Returns
-
-`this`
-
-***
-
-### registerFormat()
-
-> `static` **registerFormat**(`name`, `definition`): `void`
-
-Defined in: [packages/mdast-plus/src/pipeline.ts:40](https://github.com/isdk/mdast-plus.js/blob/75ee549d3fb31ef4bc1b4a6b3307f6368072874e/src/pipeline.ts#L40)
-
-Registers a new format definition.
-
-#### Parameters
-
-##### name
-
-`string`
-
-The name of the format (e.g., 'docx')
-
-##### definition
-
-[`MdastFormatDefinition`](../interfaces/MdastFormatDefinition.md)
-
-The format definition containing parse/stringify logic
-
-#### Returns
-
-`void`

package/docs/functions/htmlStringify.md

@@ -1,23 +0,0 @@
-[**@isdk/mdast-plus**](../README.md)
-
-***
-
-[@isdk/mdast-plus](../globals.md) / htmlStringify
-
-# Function: htmlStringify()
-
-> **htmlStringify**(`this`): `void`
-
-Defined in: [packages/mdast-plus/src/formats/html.ts:12](https://github.com/isdk/mdast-plus.js/blob/75ee549d3fb31ef4bc1b4a6b3307f6368072874e/src/formats/html.ts#L12)
-
-Standard compiler/stringifier for HTML.
-
-## Parameters
-
-### this
-
-`any`
-
-## Returns
-
-`void`

package/docs/functions/markdownCommon.md

@@ -1,23 +0,0 @@
-[**@isdk/mdast-plus**](../README.md)
-
-***
-
-[@isdk/mdast-plus](../globals.md) / markdownCommon
-
-# Function: markdownCommon()
-
-> **markdownCommon**(`this`): `void`
-
-Defined in: [packages/mdast-plus/src/formats/markdown.ts:13](https://github.com/isdk/mdast-plus.js/blob/75ee549d3fb31ef4bc1b4a6b3307f6368072874e/src/formats/markdown.ts#L13)
-
-Common remark configuration for Markdown.
-
-## Parameters
-
-### this
-
-`any`
-
-## Returns
-
-`void`

package/docs/interfaces/ConvertResult.md

@@ -1,39 +0,0 @@
-[**@isdk/mdast-plus**](../README.md)
-
-***
-
-[@isdk/mdast-plus](../globals.md) / ConvertResult
-
-# Interface: ConvertResult\<T\>
-
-Defined in: [packages/mdast-plus/src/types.ts:50](https://github.com/isdk/mdast-plus.js/blob/75ee549d3fb31ef4bc1b4a6b3307f6368072874e/src/types.ts#L50)
-
-Result of a conversion process.
-
-## Type Parameters
-
-### T
-
-`T` = `string`
-
-The type of the main content (default: string)
-
-## Properties
-
-### assets
-
-> **assets**: [`MdastAsset`](MdastAsset.md)[]
-
-Defined in: [packages/mdast-plus/src/types.ts:54](https://github.com/isdk/mdast-plus.js/blob/75ee549d3fb31ef4bc1b4a6b3307f6368072874e/src/types.ts#L54)
-
-Extracted assets
-
-***
-
-### content
-
-> **content**: `T`
-
-Defined in: [packages/mdast-plus/src/types.ts:52](https://github.com/isdk/mdast-plus.js/blob/75ee549d3fb31ef4bc1b4a6b3307f6368072874e/src/types.ts#L52)
-
-The converted content

package/docs/interfaces/MdastAsset.md

@@ -1,41 +0,0 @@
-[**@isdk/mdast-plus**](../README.md)
-
-***
-
-[@isdk/mdast-plus](../globals.md) / MdastAsset
-
-# Interface: MdastAsset
-
-Defined in: [packages/mdast-plus/src/types.ts:37](https://github.com/isdk/mdast-plus.js/blob/75ee549d3fb31ef4bc1b4a6b3307f6368072874e/src/types.ts#L37)
-
-Represents an asset (e.g., image) extracted during processing.
-
-## Properties
-
-### bytes
-
-> **bytes**: `Uint8Array`
-
-Defined in: [packages/mdast-plus/src/types.ts:43](https://github.com/isdk/mdast-plus.js/blob/75ee549d3fb31ef4bc1b4a6b3307f6368072874e/src/types.ts#L43)
-
-Raw content as bytes
-
-***
-
-### contentType
-
-> **contentType**: `string`
-
-Defined in: [packages/mdast-plus/src/types.ts:41](https://github.com/isdk/mdast-plus.js/blob/75ee549d3fb31ef4bc1b4a6b3307f6368072874e/src/types.ts#L41)
-
-MIME type of the asset
-
-***
-
-### path
-
-> **path**: `string`
-
-Defined in: [packages/mdast-plus/src/types.ts:39](https://github.com/isdk/mdast-plus.js/blob/75ee549d3fb31ef4bc1b4a6b3307f6368072874e/src/types.ts#L39)
-
-Relative path or identifier for the asset

package/docs/interfaces/MdastFormatDefinition.md

@@ -1,51 +0,0 @@
-[**@isdk/mdast-plus**](../README.md)
-
-***
-
-[@isdk/mdast-plus](../globals.md) / MdastFormatDefinition
-
-# Interface: MdastFormatDefinition
-
-Defined in: [packages/mdast-plus/src/types.ts:27](https://github.com/isdk/mdast-plus.js/blob/75ee549d3fb31ef4bc1b4a6b3307f6368072874e/src/types.ts#L27)
-
-Definition for an mdast format (parser/stringifier).
-
-## Properties
-
-### parse()?
-
-> `optional` **parse**: (`processor`) => `void`
-
-Defined in: [packages/mdast-plus/src/types.ts:29](https://github.com/isdk/mdast-plus.js/blob/75ee549d3fb31ef4bc1b4a6b3307f6368072874e/src/types.ts#L29)
-
-Function to register parser plugins
-
-#### Parameters
-
-##### processor
-
-`any`
-
-#### Returns
-
-`void`
-
-***
-
-### stringify()?
-
-> `optional` **stringify**: (`processor`) => `void`
-
-Defined in: [packages/mdast-plus/src/types.ts:31](https://github.com/isdk/mdast-plus.js/blob/75ee549d3fb31ef4bc1b4a6b3307f6368072874e/src/types.ts#L31)
-
-Function to register stringifier plugins
-
-#### Parameters
-
-##### processor
-
-`any`
-
-#### Returns
-
-`void`

package/docs/interfaces/MdastReader.md

@@ -1,41 +0,0 @@
-[**@isdk/mdast-plus**](../README.md)
-
-***
-
-[@isdk/mdast-plus](../globals.md) / MdastReader
-
-# Interface: MdastReader\<I\>
-
-Defined in: [packages/mdast-plus/src/types.ts:131](https://github.com/isdk/mdast-plus.js/blob/75ee549d3fb31ef4bc1b4a6b3307f6368072874e/src/types.ts#L131)
-
-Interface for reading input into an mdast tree.
-
-## Type Parameters
-
-### I
-
-`I`
-
-Input type
-
-## Methods
-
-### read()
-
-> **read**(`input`): `Promise`\<`Root`\>
-
-Defined in: [packages/mdast-plus/src/types.ts:136](https://github.com/isdk/mdast-plus.js/blob/75ee549d3fb31ef4bc1b4a6b3307f6368072874e/src/types.ts#L136)
-
-Reads input and returns an mdast Root node.
-
-#### Parameters
-
-##### input
-
-`I`
-
-The input to read
-
-#### Returns
-
-`Promise`\<`Root`\>

package/docs/interfaces/MdastTransformer.md

@@ -1,33 +0,0 @@
-[**@isdk/mdast-plus**](../README.md)
-
-***
-
-[@isdk/mdast-plus](../globals.md) / MdastTransformer
-
-# Interface: MdastTransformer
-
-Defined in: [packages/mdast-plus/src/types.ts:142](https://github.com/isdk/mdast-plus.js/blob/75ee549d3fb31ef4bc1b4a6b3307f6368072874e/src/types.ts#L142)
-
-Interface for transforming an mdast tree.
-
-## Methods
-
-### transform()
-
-> **transform**(`tree`): `Promise`\<\{ `assets?`: [`MdastAsset`](MdastAsset.md)[]; `tree`: `Root`; \}\>
-
-Defined in: [packages/mdast-plus/src/types.ts:147](https://github.com/isdk/mdast-plus.js/blob/75ee549d3fb31ef4bc1b4a6b3307f6368072874e/src/types.ts#L147)
-
-Transforms the given mdast tree.
-
-#### Parameters
-
-##### tree
-
-`Root`
-
-The Root node to transform
-
-#### Returns
-
-`Promise`\<\{ `assets?`: [`MdastAsset`](MdastAsset.md)[]; `tree`: `Root`; \}\>

package/docs/interfaces/MdastWriter.md

@@ -1,47 +0,0 @@
-[**@isdk/mdast-plus**](../README.md)
-
-***
-
-[@isdk/mdast-plus](../globals.md) / MdastWriter
-
-# Interface: MdastWriter\<Output\>
-
-Defined in: [packages/mdast-plus/src/types.ts:154](https://github.com/isdk/mdast-plus.js/blob/75ee549d3fb31ef4bc1b4a6b3307f6368072874e/src/types.ts#L154)
-
-Interface for writing an mdast tree to an output format.
-
-## Type Parameters
-
-### Output
-
-`Output` = `string`
-
-Output type (default: string)
-
-## Methods
-
-### write()
-
-> **write**(`tree`, `assets?`): `Promise`\<[`ConvertResult`](ConvertResult.md)\<`Output`\>\>
-
-Defined in: [packages/mdast-plus/src/types.ts:160](https://github.com/isdk/mdast-plus.js/blob/75ee549d3fb31ef4bc1b4a6b3307f6368072874e/src/types.ts#L160)
-
-Writes the mdast tree to the target output.
-
-#### Parameters
-
-##### tree
-
-`Root`
-
-The Root node to write
-
-##### assets?
-
-[`MdastAsset`](MdastAsset.md)[]
-
-Optional assets to include
-
-#### Returns
-
-`Promise`\<[`ConvertResult`](ConvertResult.md)\<`Output`\>\>

package/docs/type-aliases/Stage.md

@@ -1,13 +0,0 @@
-[**@isdk/mdast-plus**](../README.md)
-
-***
-
-[@isdk/mdast-plus](../globals.md) / Stage
-
-# Type Alias: Stage
-
-> **Stage** = `"normalize"` \| `"compile"` \| `"finalize"`
-
-Defined in: [packages/mdast-plus/src/types.ts:8](https://github.com/isdk/mdast-plus.js/blob/75ee549d3fb31ef4bc1b4a6b3307f6368072874e/src/types.ts#L8)
-
-Stages for mdast-plus pipeline processing.