@markdown-for-agents/hono 0.1.2 → 0.2.0

package/README.md

@@ -10,6 +10,9 @@ The middleware uses content negotiation. When a client sends `Accept: text/markd
 
 - `Content-Type: text/markdown; charset=utf-8`
 - `x-markdown-tokens` header with the token count
+- `ETag` header with a content hash for cache validation
+- `Vary: Accept` header so CDNs cache HTML and Markdown separately
+- `content-signal` header with publisher consent signals (when configured)
 
 ## Install
 
@@ -58,7 +61,10 @@ app.use(
         deduplicate: true,
 
         // Custom token counter (e.g. tiktoken)
-        tokenCounter: text => ({ tokens: enc.encode(text).length, characters: text.length, words: text.split(/\s+/).filter(Boolean).length })
+        tokenCounter: text => ({ tokens: enc.encode(text).length, characters: text.length, words: text.split(/\s+/).filter(Boolean).length }),
+
+        // Publisher consent signal header
+        contentSignal: { aiTrain: true, search: true, aiInput: true }
     })
 );
 ```

package/dist/index.mjs

@@ -1,4 +1,4 @@
-import { convert } from "markdown-for-agents";
+import { buildContentSignalHeader, convert } from "markdown-for-agents";
 
 //#region src/index.ts
 /**
@@ -20,16 +20,22 @@ import { convert } from "markdown-for-agents";
 function markdown(options) {
 	const tokenHeader = options?.tokenHeader ?? "x-markdown-tokens";
 	return async (c, next) => {
-		if (!(c.req.header("accept") ?? "").includes("text/markdown")) return next();
 		await next();
+		c.res.headers.append("vary", "Accept");
+		if (!(c.req.header("accept") ?? "").includes("text/markdown")) return;
 		if (!(c.res.headers.get("content-type") ?? "").includes("text/html")) return;
-		const { markdown: md, tokenEstimate } = convert(await c.res.text(), options);
+		const { markdown: md, tokenEstimate, contentHash } = convert(await c.res.text(), options);
 		c.res = new Response(md, {
 			status: c.res.status,
 			headers: c.res.headers
 		});
 		c.res.headers.set("content-type", "text/markdown; charset=utf-8");
 		c.res.headers.set(tokenHeader, String(tokenEstimate.tokens));
+		c.res.headers.set("etag", `"${contentHash}"`);
+		if (options?.contentSignal) {
+			const signalValue = buildContentSignalHeader(options.contentSignal);
+			if (signalValue) c.res.headers.set("content-signal", signalValue);
+		}
 	};
 }
 

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","names":[],"sources":["../src/index.ts"],"sourcesContent":["import type { MiddlewareHandler } from 'hono';\nimport { convert } from 'markdown-for-agents';\nimport type { MiddlewareOptions } from 'markdown-for-agents';\n\nexport type { MiddlewareOptions } from 'markdown-for-agents';\n\n/**\n * Hono middleware that converts HTML responses to markdown\n * when the client sends an `Accept: text/markdown` header.\n *\n * @param options - Conversion and middleware options.\n * @returns A Hono middleware handler.\n *\n * @example\n * ```ts\n * import { Hono } from \"hono\";\n * import { markdown } from \"@markdown-for-agents/hono\";\n *\n * const app = new Hono();\n * app.use(\"*\", markdown());\n * ```\n */\nexport function markdown(options?: MiddlewareOptions): MiddlewareHandler {\n    const tokenHeader = options?.tokenHeader ?? 'x-markdown-tokens';\n\n    return async (c, next) => {\n        const accept = c.req.header('accept') ?? '';\n        if (!accept.includes('text/markdown')) {\n            return next();\n        }\n\n        await next();\n\n        const contentType = c.res.headers.get('content-type') ?? '';\n        if (!contentType.includes('text/html')) return;\n\n        const html = await c.res.text();\n        const { markdown: md, tokenEstimate } = convert(html, options);\n\n        c.res = new Response(md, {\n            status: c.res.status,\n            headers: c.res.headers\n        });\n        c.res.headers.set('content-type', 'text/markdown; charset=utf-8');\n        c.res.headers.set(tokenHeader, String(tokenEstimate.tokens));\n    };\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;AAsBA,SAAgB,SAAS,SAAgD;CACrE,MAAM,cAAc,SAAS,eAAe;AAE5C,QAAO,OAAO,GAAG,SAAS;AAEtB,MAAI,EADW,EAAE,IAAI,OAAO,SAAS,IAAI,IAC7B,SAAS,gBAAgB,CACjC,QAAO,MAAM;AAGjB,QAAM,MAAM;AAGZ,MAAI,EADgB,EAAE,IAAI,QAAQ,IAAI,eAAe,IAAI,IACxC,SAAS,YAAY,CAAE;EAGxC,MAAM,EAAE,UAAU,IAAI,kBAAkB,QAD3B,MAAM,EAAE,IAAI,MAAM,EACuB,QAAQ;AAE9D,IAAE,MAAM,IAAI,SAAS,IAAI;GACrB,QAAQ,EAAE,IAAI;GACd,SAAS,EAAE,IAAI;GAClB,CAAC;AACF,IAAE,IAAI,QAAQ,IAAI,gBAAgB,+BAA+B;AACjE,IAAE,IAAI,QAAQ,IAAI,aAAa,OAAO,cAAc,OAAO,CAAC"}
+{"version":3,"file":"index.mjs","names":[],"sources":["../src/index.ts"],"sourcesContent":["import type { MiddlewareHandler } from 'hono';\nimport { convert, buildContentSignalHeader } from 'markdown-for-agents';\nimport type { MiddlewareOptions } from 'markdown-for-agents';\n\nexport type { MiddlewareOptions } from 'markdown-for-agents';\n\n/**\n * Hono middleware that converts HTML responses to markdown\n * when the client sends an `Accept: text/markdown` header.\n *\n * @param options - Conversion and middleware options.\n * @returns A Hono middleware handler.\n *\n * @example\n * ```ts\n * import { Hono } from \"hono\";\n * import { markdown } from \"@markdown-for-agents/hono\";\n *\n * const app = new Hono();\n * app.use(\"*\", markdown());\n * ```\n */\nexport function markdown(options?: MiddlewareOptions): MiddlewareHandler {\n    const tokenHeader = options?.tokenHeader ?? 'x-markdown-tokens';\n\n    return async (c, next) => {\n        await next();\n\n        // Always signal that responses vary by Accept so caches store\n        // separate entries for HTML and Markdown representations.\n        c.res.headers.append('vary', 'Accept');\n\n        const accept = c.req.header('accept') ?? '';\n        if (!accept.includes('text/markdown')) return;\n\n        const contentType = c.res.headers.get('content-type') ?? '';\n        if (!contentType.includes('text/html')) return;\n\n        const html = await c.res.text();\n        const { markdown: md, tokenEstimate, contentHash } = convert(html, options);\n\n        c.res = new Response(md, {\n            status: c.res.status,\n            headers: c.res.headers\n        });\n        c.res.headers.set('content-type', 'text/markdown; charset=utf-8');\n        c.res.headers.set(tokenHeader, String(tokenEstimate.tokens));\n        c.res.headers.set('etag', `\"${contentHash}\"`);\n        if (options?.contentSignal) {\n            const signalValue = buildContentSignalHeader(options.contentSignal);\n            if (signalValue) c.res.headers.set('content-signal', signalValue);\n        }\n    };\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;AAsBA,SAAgB,SAAS,SAAgD;CACrE,MAAM,cAAc,SAAS,eAAe;AAE5C,QAAO,OAAO,GAAG,SAAS;AACtB,QAAM,MAAM;AAIZ,IAAE,IAAI,QAAQ,OAAO,QAAQ,SAAS;AAGtC,MAAI,EADW,EAAE,IAAI,OAAO,SAAS,IAAI,IAC7B,SAAS,gBAAgB,CAAE;AAGvC,MAAI,EADgB,EAAE,IAAI,QAAQ,IAAI,eAAe,IAAI,IACxC,SAAS,YAAY,CAAE;EAGxC,MAAM,EAAE,UAAU,IAAI,eAAe,gBAAgB,QADxC,MAAM,EAAE,IAAI,MAAM,EACoC,QAAQ;AAE3E,IAAE,MAAM,IAAI,SAAS,IAAI;GACrB,QAAQ,EAAE,IAAI;GACd,SAAS,EAAE,IAAI;GAClB,CAAC;AACF,IAAE,IAAI,QAAQ,IAAI,gBAAgB,+BAA+B;AACjE,IAAE,IAAI,QAAQ,IAAI,aAAa,OAAO,cAAc,OAAO,CAAC;AAC5D,IAAE,IAAI,QAAQ,IAAI,QAAQ,IAAI,YAAY,GAAG;AAC7C,MAAI,SAAS,eAAe;GACxB,MAAM,cAAc,yBAAyB,QAAQ,cAAc;AACnE,OAAI,YAAa,GAAE,IAAI,QAAQ,IAAI,kBAAkB,YAAY"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@markdown-for-agents/hono",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "description": "Hono middleware for markdown-for-agents",
   "type": "module",
   "sideEffects": false,
@@ -20,7 +20,7 @@
   "main": "./dist/index.mjs",
   "types": "./dist/index.d.mts",
   "dependencies": {
-    "markdown-for-agents": "0.1.2"
+    "markdown-for-agents": "0.2.0"
   },
   "peerDependencies": {
     "hono": ">=4.0.0"