flex-md 1.0.0 → 1.1.0

package/README.md

@@ -28,9 +28,17 @@ console.log(doc.frames[0]?.type); // "message"
 
 const back = stringifyFlexMd(doc, { skipEmpty: true });
 console.log(back);
+
+// New in v1.1.0: Validation
+import { validateFlexMd } from "flex-md";
+const result = validateFlexMd(md);
+if (!result.valid) {
+  console.log("Validation errors:", result.errors);
+}
 ```
 
 ### Notes
 - Frames start with: `[[type key=value ...]]`
 - Metadata lines: `@key: value`
 - Payload binding: `@payload:name: X` then the next fenced block is payload X
+- **Validation**: `validateFlexMd` checks for unterminated frames, dangling payload declarations, and unterminated code fences.

package/dist/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./types.js";
 export { parseFlexMd } from "./parser.js";
 export { stringifyFlexMd } from "./stringify.js";
+export { validateFlexMd } from "./validator.js";

package/dist/index.js

@@ -1,3 +1,4 @@
 export * from "./types.js";
 export { parseFlexMd } from "./parser.js";
 export { stringifyFlexMd } from "./stringify.js";
+export { validateFlexMd } from "./validator.js";

package/dist/types.d.ts

@@ -47,3 +47,12 @@ export interface StringifyOptions {
      */
     fence?: "```" | "~~~";
 }
+export interface FlexValidationError {
+    line: number;
+    message: string;
+    severity: "error" | "warning";
+}
+export interface FlexValidationResult {
+    valid: boolean;
+    errors: FlexValidationError[];
+}

package/dist/validator.d.ts

@@ -0,0 +1,2 @@
+import type { FlexValidationResult } from "./types.js";
+export declare function validateFlexMd(input: string): FlexValidationResult;

package/dist/validator.js

@@ -0,0 +1,80 @@
+const HEADER_START = "[[";
+const HEADER_END = "]]";
+const PAYLOAD_DECL_RE = /^@payload:name:\s*(.+)\s*$/;
+const FENCE_RE = /^(```|~~~)/;
+export function validateFlexMd(input) {
+    const lines = input.split("\n");
+    const errors = [];
+    let inFence = null;
+    let pendingPayloadLine = null;
+    for (let i = 0; i < lines.length; i++) {
+        const line = lines[i];
+        const lineNum = i + 1;
+        // Check for unterminated headers
+        if (line.includes(HEADER_START) && !line.includes(HEADER_END)) {
+            // Small check: if it really looks like a header start at beginning of line
+            if (line.trim().startsWith(HEADER_START)) {
+                errors.push({
+                    line: lineNum,
+                    message: "Possible unterminated frame header (missing ']]')",
+                    severity: "error",
+                });
+            }
+        }
+        // Handle code fences
+        const fenceMatch = line.match(FENCE_RE);
+        if (fenceMatch) {
+            const fence = fenceMatch[1];
+            if (inFence) {
+                if (line.trimEnd() === inFence) {
+                    inFence = null;
+                    pendingPayloadLine = null; // Payload satisfied
+                }
+            }
+            else {
+                inFence = fence;
+            }
+        }
+        else if (pendingPayloadLine !== null && !inFence && line.trim().length > 0) {
+            // We had a @payload:name: but the next non-empty line wasn't a fence
+            errors.push({
+                line: pendingPayloadLine,
+                message: "Payload declaration not followed by a code fence",
+                severity: "warning",
+            });
+            pendingPayloadLine = null;
+        }
+        // Check for payload declarations
+        const payloadMatch = line.match(PAYLOAD_DECL_RE);
+        if (payloadMatch) {
+            if (inFence) {
+                errors.push({
+                    line: lineNum,
+                    message: "Payload declaration inside a code fence",
+                    severity: "warning",
+                });
+            }
+            else {
+                pendingPayloadLine = lineNum;
+            }
+        }
+    }
+    if (inFence) {
+        errors.push({
+            line: lines.length,
+            message: "Unterminated code fence at end of document",
+            severity: "error",
+        });
+    }
+    if (pendingPayloadLine !== null) {
+        errors.push({
+            line: pendingPayloadLine,
+            message: "Dangling payload declaration at end of document",
+            severity: "warning",
+        });
+    }
+    return {
+        valid: !errors.some((e) => e.severity === "error"),
+        errors,
+    };
+}

package/package.json

@@ -1,10 +1,17 @@
 {
   "name": "flex-md",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Parse and stringify FlexMD Frames (semi-structured Markdown) to/from JSON.",
   "license": "MIT",
   "author": "",
-  "keywords": ["markdown", "parser", "serialization", "llm", "prompting", "semi-structured"],
+  "keywords": [
+    "markdown",
+    "parser",
+    "serialization",
+    "llm",
+    "prompting",
+    "semi-structured"
+  ],
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
@@ -16,7 +23,9 @@
       "require": "./dist/index.cjs"
     }
   },
-  "files": ["dist"],
+  "files": [
+    "dist"
+  ],
   "scripts": {
     "build": "tsc && node ./scripts/cjs-bridge.mjs",
     "test": "node ./dist/index.js"
@@ -24,4 +33,4 @@
   "devDependencies": {
     "typescript": "^5.6.3"
   }
-}
+}