flex-md 3.0.0 → 3.1.0

package/dist/__tests__/ofs.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/__tests__/ofs.test.js

@@ -0,0 +1,51 @@
+import { describe, it, expect } from "vitest";
+import { stringifyOutputFormatSpec } from "../ofs/stringify.js";
+import { buildMarkdownGuidance } from "../ofs/enricher.js";
+describe("OFS Object-to-Prompt Flow", () => {
+    const spec = {
+        description: "Standard report format for technical analysis.",
+        sections: [
+            {
+                name: "Summary",
+                kind: "text",
+                required: true,
+                description: "A brief summary of the topic.",
+                instruction: "Keep it under 3 sentences."
+            },
+            {
+                name: "Key Points",
+                kind: "list",
+                required: false,
+                description: "Important takeaways."
+            }
+        ],
+        emptySectionValue: "N/A"
+    };
+    it("should stringify an OFS object correctly", () => {
+        const md = stringifyOutputFormatSpec(spec);
+        expect(md).toContain("## Output format (Markdown)");
+        expect(md).toContain("Standard report format for technical analysis.");
+        expect(md).toContain("- Summary — text (required)");
+        expect(md).toContain("Description: A brief summary of the topic.");
+        expect(md).toContain("Instruction: Keep it under 3 sentences.");
+        expect(md).toContain("- Key Points — list (optional)");
+        expect(md).toContain("Description: Important takeaways.");
+        expect(md).toContain("If a section is empty, write `N/A`.");
+    });
+    it("should build markdown guidance (L1) correctly", () => {
+        const guidance = buildMarkdownGuidance(spec, { level: 1 });
+        expect(guidance).toContain("Include these section headings somewhere");
+        expect(guidance).toContain("- Summary");
+        expect(guidance).toContain("Description: A brief summary of the topic.");
+        expect(guidance).toContain("Instruction: Keep it under 3 sentences.");
+        expect(guidance).toContain("- Key Points");
+        expect(guidance).toContain("Description: Important takeaways.");
+    });
+    it("should build markdown guidance (L3) correctly", () => {
+        const guidance = buildMarkdownGuidance(spec, { level: 3 });
+        expect(guidance).toContain("Return your entire answer inside a single ```markdown fenced block");
+        expect(guidance).toContain("- Summary");
+        expect(guidance).toContain("- Key Points (list)");
+        expect(guidance).toContain("Do not return JSON");
+    });
+});

package/dist/ofs/enricher.js

@@ -31,6 +31,14 @@ export function buildMarkdownGuidance(spec, strict, opts) {
                 suffix = " (ordered list)";
         }
         lines.push(`- ${s.name}${suffix}`);
+        if (level >= 1) {
+            if (s.description) {
+                lines.push(`  Description: ${s.description}`);
+            }
+            if (s.instruction) {
+                lines.push(`  Instruction: ${s.instruction}`);
+            }
+        }
     }
     lines.push("");
     // None Rule

package/dist/ofs/stringify.js

@@ -4,12 +4,22 @@
 export function stringifyOutputFormatSpec(spec) {
     const lines = [];
     lines.push(`## Output format (Markdown)`);
+    if (spec.description) {
+        lines.push(spec.description);
+        lines.push("");
+    }
     lines.push(`Include these sections somewhere (order does not matter):`);
     lines.push("");
     for (const s of spec.sections) {
         const k = s.kind === "ordered_list" ? "ordered list" : (s.kind || "text");
         const required = s.required === true ? " (required)" : (s.required === false ? " (optional)" : "");
         lines.push(`- ${s.name} — ${k}${required}`);
+        if (s.description) {
+            lines.push(`  Description: ${s.description}`);
+        }
+        if (s.instruction) {
+            lines.push(`  Instruction: ${s.instruction}`);
+        }
     }
     const tables = spec.tables || [];
     if (tables.length) {

package/dist/types.d.ts

@@ -86,6 +86,8 @@ export interface OutputSectionSpec {
     kind?: SectionKind;
     required?: boolean;
     columns?: string[];
+    description?: string;
+    instruction?: string;
 }
 /**
  * @deprecated Use OutputSectionSpec
@@ -101,6 +103,7 @@ export interface OfsTable {
     required?: boolean;
 }
 export interface OutputFormatSpec {
+    description?: string;
     sections: OutputSectionSpec[];
     emptySectionValue?: string;
     descriptorType?: "output_format_spec";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "flex-md",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "description": "Parse and stringify FlexMD: semi-structured Markdown with three powerful layers - Frames, Output Format Spec (OFS), and Detection/Extraction.",
   "license": "MIT",
   "author": "",