@plurnk/plurnk-mimetypes-text-markdown 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 PossumTech Laboratories, LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,29 @@
+# @plurnk/plurnk-mimetypes-text-markdown
+
+`text/markdown` mimetype handler for [plurnk-service](https://github.com/plurnk/plurnk-service).
+
+## install
+
+```
+npm i @plurnk/plurnk-mimetypes-text-markdown
+```
+
+## interface
+
+Default export is a class implementing the plurnk mimetype handler contract (see plurnk-service `MIMETYPES.md`):
+
+```ts
+class TextMarkdown {
+    readonly mimetype = "text/markdown";
+    readonly glyph = "📝";
+    validate(content: string): void;
+    symbols(content: string): string;
+    preview(content: string, budget: number): string;
+}
+```
+
+`symbols` extracts an indented heading outline from the source. `preview` returns the outline (when headings exist) or the body otherwise, truncated to `budget` characters.
+
+## license
+
+MIT.

package/dist/TextMarkdown.d.ts

@@ -0,0 +1,8 @@
+export default class TextMarkdown {
+    readonly mimetype = "text/markdown";
+    readonly glyph = "\uD83D\uDCDD";
+    validate(_content: string): void;
+    symbols(content: string): string;
+    preview(content: string, budget: number): string;
+}
+//# sourceMappingURL=TextMarkdown.d.ts.map

package/dist/TextMarkdown.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TextMarkdown.d.ts","sourceRoot":"","sources":["../src/TextMarkdown.ts"],"names":[],"mappings":"AAQA,MAAM,CAAC,OAAO,OAAO,YAAY;IAC7B,QAAQ,CAAC,QAAQ,mBAAmB;IACpC,QAAQ,CAAC,KAAK,kBAAQ;IAEtB,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAIhC,OAAO,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;IAchC,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM;CAKnD"}

package/dist/TextMarkdown.js

@@ -0,0 +1,34 @@
+// text/markdown mimetype handler for plurnk-service. Implements the
+// MimetypeHandler duck contract (see MIMETYPES.md in plurnk-service):
+// - mimetype: string — declared mimetype identifier
+// - glyph: string — single-character display marker
+// - validate(content) — throw on malformed content (markdown accepts anything)
+// - symbols(content) — structural outline (heading hierarchy)
+// - preview(content, budget) — bounded structural view for index tiles
+export default class TextMarkdown {
+    mimetype = "text/markdown";
+    glyph = "📝";
+    validate(_content) {
+        // any string is valid markdown
+    }
+    symbols(content) {
+        const lines = content.split("\n");
+        const headings = [];
+        for (const line of lines) {
+            const match = line.match(/^(#{1,6})\s+(.+?)\s*$/);
+            if (match === null)
+                continue;
+            const level = match[1].length;
+            const text = match[2];
+            const indent = "  ".repeat(level - 1);
+            headings.push(`${indent}${text}`);
+        }
+        return headings.join("\n");
+    }
+    preview(content, budget) {
+        const outline = this.symbols(content);
+        const result = outline.length > 0 ? outline : content;
+        return result.length <= budget ? result : result.slice(0, budget);
+    }
+}
+//# sourceMappingURL=TextMarkdown.js.map

package/dist/TextMarkdown.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TextMarkdown.js","sourceRoot":"","sources":["../src/TextMarkdown.ts"],"names":[],"mappings":"AAAA,oEAAoE;AACpE,sEAAsE;AACtE,oDAAoD;AACpD,oDAAoD;AACpD,+EAA+E;AAC/E,8DAA8D;AAC9D,uEAAuE;AAEvE,MAAM,CAAC,OAAO,OAAO,YAAY;IACpB,QAAQ,GAAG,eAAe,CAAC;IAC3B,KAAK,GAAG,IAAI,CAAC;IAEtB,QAAQ,CAAC,QAAgB;QACrB,+BAA+B;IACnC,CAAC;IAED,OAAO,CAAC,OAAe;QACnB,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAClC,MAAM,QAAQ,GAAa,EAAE,CAAC;QAC9B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACvB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAC;YAClD,IAAI,KAAK,KAAK,IAAI;gBAAE,SAAS;YAC7B,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;YAC9B,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YACtB,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;YACtC,QAAQ,CAAC,IAAI,CAAC,GAAG,MAAM,GAAG,IAAI,EAAE,CAAC,CAAC;QACtC,CAAC;QACD,OAAO,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAED,OAAO,CAAC,OAAe,EAAE,MAAc;QACnC,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC;QACtD,OAAO,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;IACtE,CAAC;CACJ"}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { default } from "./TextMarkdown.ts";
+export { default as TextMarkdown } from "./TextMarkdown.ts";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,mBAAmB,CAAC"}

package/dist/index.js

@@ -0,0 +1,3 @@
+export { default } from "./TextMarkdown.js";
+export { default as TextMarkdown } from "./TextMarkdown.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,mBAAmB,CAAC"}

package/package.json

@@ -0,0 +1,40 @@
+{
+    "name": "@plurnk/plurnk-mimetypes-text-markdown",
+    "version": "0.1.0",
+    "description": "text/markdown mimetype handler for plurnk-service.",
+    "type": "module",
+    "license": "MIT",
+    "publishConfig": {
+        "access": "public"
+    },
+    "engines": {
+        "node": ">=25"
+    },
+    "plurnk": {
+        "kind": "mimetype",
+        "name": "text/markdown"
+    },
+    "exports": {
+        ".": {
+            "types": "./dist/index.d.ts",
+            "default": "./dist/index.js"
+        },
+        "./package.json": "./package.json"
+    },
+    "files": [
+        "dist/**/*",
+        "README.md"
+    ],
+    "scripts": {
+        "test:lint": "tsc --noEmit",
+        "test:unit": "node --test src/**/*.test.ts",
+        "test": "npm run test:lint && npm run test:unit",
+        "build:dist": "tsc -p tsconfig.build.json",
+        "build": "npm run build:dist",
+        "prepare": "npm run build"
+    },
+    "devDependencies": {
+        "@types/node": "^25.8.0",
+        "typescript": "^6.0.3"
+    }
+}