markform 0.1.20 → 0.1.22

package/dist/urlFormat-lls7CsEP.mjs

@@ -0,0 +1,71 @@
+
+//#region src/utils/urlFormat.ts
+/**
+* Create a friendly abbreviated display name for a URL.
+* - Drops "www." prefix from domain
+* - Adds first portion of path (up to maxPathChars) if present
+* - Adds ellipsis (…) if path is truncated
+*
+* @param url - The URL to abbreviate
+* @param maxPathChars - Maximum characters to include from the path (default: 12)
+* @returns Friendly abbreviated URL (e.g., "example.com/docs/api…")
+*/
+function friendlyUrlAbbrev(url, maxPathChars = 12) {
+	try {
+		const parsed = new URL(url);
+		let hostname = parsed.hostname;
+		if (hostname.startsWith("www.")) hostname = hostname.slice(4);
+		const path = parsed.pathname.slice(1);
+		if (!path) return hostname;
+		if (path.length <= maxPathChars) return `${hostname}/${path}`;
+		return `${hostname}/${path.slice(0, maxPathChars)}…`;
+	} catch {
+		let result = url;
+		result = result.replace(/^https?:\/\//, "");
+		result = result.replace(/^www\./, "");
+		const maxLen = 30;
+		if (result.length > maxLen) return result.slice(0, maxLen) + "…";
+		return result;
+	}
+}
+/**
+* Format a URL as a markdown link with a friendly abbreviated display text.
+* The full URL is preserved as the link target.
+*
+* @param url - The URL to format
+* @returns Markdown link in format [friendly-abbrev](url)
+*/
+function formatUrlAsMarkdownLink(url) {
+	return `[${friendlyUrlAbbrev(url)}](${url})`;
+}
+/**
+* Format bare URLs in text as HTML links with abbreviated display text.
+* Also handles markdown-style links [text](url) for consistency.
+*
+* Processing order:
+* 1. Escape all HTML to prevent XSS
+* 2. Convert markdown links [text](url) to <a> tags
+* 3. Convert bare URLs (not already in links) to <a> tags with abbreviated display
+*
+* @param text - The raw text containing URLs (will be HTML-escaped)
+* @param escapeHtml - Function to escape HTML entities
+* @returns HTML-safe text with URLs converted to <a> tags
+*/
+function formatBareUrlsAsHtmlLinks(text, escapeHtml) {
+	let result = escapeHtml(text);
+	result = result.replace(/\[([^\]]+)\]\(([^)]+)\)/g, (_match, linkText, url) => {
+		const cleanUrl = url.replace(/&amp;/g, "&");
+		return `<a href="${escapeHtml(cleanUrl)}" target="_blank" class="url-link" data-url="${escapeHtml(cleanUrl)}">${linkText}</a>`;
+	});
+	result = result.replace(/(?<!href="|data-url="|">)(?:https?:\/\/|www\.)[^\s<>"]+(?<![.,;:!?'")])/g, (url) => {
+		const cleanUrl = url.replace(/&amp;/g, "&");
+		const fullUrl = cleanUrl.startsWith("www.") ? `https://${cleanUrl}` : cleanUrl;
+		const display = friendlyUrlAbbrev(fullUrl);
+		return `<a href="${escapeHtml(fullUrl)}" target="_blank" class="url-link" data-url="${escapeHtml(fullUrl)}">${escapeHtml(display)}</a>`;
+	});
+	return result;
+}
+
+//#endregion
+export { formatUrlAsMarkdownLink as n, friendlyUrlAbbrev as r, formatBareUrlsAsHtmlLinks as t };
+//# sourceMappingURL=urlFormat-lls7CsEP.mjs.map

package/dist/urlFormat-lls7CsEP.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"urlFormat-lls7CsEP.mjs","names":[],"sources":["../src/utils/urlFormat.ts"],"sourcesContent":["/**\n * URL formatting utilities for display and markdown output.\n */\n\n/**\n * Extract the domain (hostname) from a URL.\n * Returns the original string if parsing fails.\n *\n * @param url - The URL to extract the domain from\n * @returns The domain (e.g., \"example.com\") or the original string if invalid\n */\nexport function extractDomain(url: string): string {\n  try {\n    const parsed = new URL(url);\n    return parsed.hostname;\n  } catch {\n    // If URL parsing fails, try to extract domain-like pattern\n    const match = /^(?:https?:\\/\\/)?(?:www\\.)?([^/\\s]+)/i.exec(url);\n    if (match?.[1]) {\n      return match[1];\n    }\n    // Return original if we can't extract a domain\n    return url;\n  }\n}\n\n/**\n * Create a friendly abbreviated display name for a URL.\n * - Drops \"www.\" prefix from domain\n * - Adds first portion of path (up to maxPathChars) if present\n * - Adds ellipsis (…) if path is truncated\n *\n * @param url - The URL to abbreviate\n * @param maxPathChars - Maximum characters to include from the path (default: 12)\n * @returns Friendly abbreviated URL (e.g., \"example.com/docs/api…\")\n */\nexport function friendlyUrlAbbrev(url: string, maxPathChars = 12): string {\n  try {\n    const parsed = new URL(url);\n    // Remove www. prefix from hostname\n    let hostname = parsed.hostname;\n    if (hostname.startsWith('www.')) {\n      hostname = hostname.slice(4);\n    }\n\n    // Get path without leading slash, excluding query string and hash\n    const path = parsed.pathname.slice(1);\n    if (!path) {\n      return hostname;\n    }\n\n    // Include path up to maxPathChars\n    if (path.length <= maxPathChars) {\n      return `${hostname}/${path}`;\n    }\n\n    // Truncate path and add ellipsis\n    return `${hostname}/${path.slice(0, maxPathChars)}…`;\n  } catch {\n    // If URL parsing fails, try basic cleanup\n    let result = url;\n    // Remove protocol\n    result = result.replace(/^https?:\\/\\//, '');\n    // Remove www.\n    result = result.replace(/^www\\./, '');\n    // Truncate if too long\n    const maxLen = 30;\n    if (result.length > maxLen) {\n      return result.slice(0, maxLen) + '…';\n    }\n    return result;\n  }\n}\n\n/**\n * Format a URL as a markdown link with a friendly abbreviated display text.\n * The full URL is preserved as the link target.\n *\n * @param url - The URL to format\n * @returns Markdown link in format [friendly-abbrev](url)\n */\nexport function formatUrlAsMarkdownLink(url: string): string {\n  const display = friendlyUrlAbbrev(url);\n  return `[${display}](${url})`;\n}\n\n/**\n * Check if a string looks like a URL.\n *\n * @param str - The string to check\n * @returns true if the string appears to be a URL\n */\nexport function isUrl(str: string): boolean {\n  // Check for common URL patterns\n  if (str.startsWith('http://') || str.startsWith('https://')) {\n    return true;\n  }\n  // Check for www. prefix\n  if (str.startsWith('www.')) {\n    return true;\n  }\n  return false;\n}\n\n/**\n * Format bare URLs in text as HTML links with abbreviated display text.\n * Also handles markdown-style links [text](url) for consistency.\n *\n * Processing order:\n * 1. Escape all HTML to prevent XSS\n * 2. Convert markdown links [text](url) to <a> tags\n * 3. Convert bare URLs (not already in links) to <a> tags with abbreviated display\n *\n * @param text - The raw text containing URLs (will be HTML-escaped)\n * @param escapeHtml - Function to escape HTML entities\n * @returns HTML-safe text with URLs converted to <a> tags\n */\nexport function formatBareUrlsAsHtmlLinks(text: string, escapeHtml: (s: string) => string): string {\n  // SECURITY: Escape the entire text first to prevent XSS\n  let result = escapeHtml(text);\n\n  // Convert markdown links [text](url) to <a> tags\n  // After escaping, we need to unescape &amp; back to & for URLs\n  result = result.replace(/\\[([^\\]]+)\\]\\(([^)]+)\\)/g, (_match, linkText: string, url: string) => {\n    const cleanUrl = url.replace(/&amp;/g, '&');\n    return `<a href=\"${escapeHtml(cleanUrl)}\" target=\"_blank\" class=\"url-link\" data-url=\"${escapeHtml(cleanUrl)}\">${linkText}</a>`;\n  });\n\n  // Convert bare URLs to <a> tags with abbreviated display\n  // Uses negative lookbehind to skip URLs that are:\n  // - Inside href=\"\" or data-url=\"\" attributes\n  // - Inside anchor tag content (preceded by \">)\n  // Pattern matches http://, https://, www. URLs\n  result = result.replace(\n    /(?<!href=\"|data-url=\"|\">)(?:https?:\\/\\/|www\\.)[^\\s<>\"]+(?<![.,;:!?'\")])/g,\n    (url: string) => {\n      // Unescape &amp; back to & for the actual URL\n      const cleanUrl = url.replace(/&amp;/g, '&');\n      // Normalize www. URLs to have https://\n      const fullUrl = cleanUrl.startsWith('www.') ? `https://${cleanUrl}` : cleanUrl;\n      const display = friendlyUrlAbbrev(fullUrl);\n      return `<a href=\"${escapeHtml(fullUrl)}\" target=\"_blank\" class=\"url-link\" data-url=\"${escapeHtml(fullUrl)}\">${escapeHtml(display)}</a>`;\n    },\n  );\n\n  return result;\n}\n"],"mappings":";;;;;;;;;;;;AAoCA,SAAgB,kBAAkB,KAAa,eAAe,IAAY;AACxE,KAAI;EACF,MAAM,SAAS,IAAI,IAAI,IAAI;EAE3B,IAAI,WAAW,OAAO;AACtB,MAAI,SAAS,WAAW,OAAO,CAC7B,YAAW,SAAS,MAAM,EAAE;EAI9B,MAAM,OAAO,OAAO,SAAS,MAAM,EAAE;AACrC,MAAI,CAAC,KACH,QAAO;AAIT,MAAI,KAAK,UAAU,aACjB,QAAO,GAAG,SAAS,GAAG;AAIxB,SAAO,GAAG,SAAS,GAAG,KAAK,MAAM,GAAG,aAAa,CAAC;SAC5C;EAEN,IAAI,SAAS;AAEb,WAAS,OAAO,QAAQ,gBAAgB,GAAG;AAE3C,WAAS,OAAO,QAAQ,UAAU,GAAG;EAErC,MAAM,SAAS;AACf,MAAI,OAAO,SAAS,OAClB,QAAO,OAAO,MAAM,GAAG,OAAO,GAAG;AAEnC,SAAO;;;;;;;;;;AAWX,SAAgB,wBAAwB,KAAqB;AAE3D,QAAO,IADS,kBAAkB,IAAI,CACnB,IAAI,IAAI;;;;;;;;;;;;;;;AAkC7B,SAAgB,0BAA0B,MAAc,YAA2C;CAEjG,IAAI,SAAS,WAAW,KAAK;AAI7B,UAAS,OAAO,QAAQ,6BAA6B,QAAQ,UAAkB,QAAgB;EAC7F,MAAM,WAAW,IAAI,QAAQ,UAAU,IAAI;AAC3C,SAAO,YAAY,WAAW,SAAS,CAAC,+CAA+C,WAAW,SAAS,CAAC,IAAI,SAAS;GACzH;AAOF,UAAS,OAAO,QACd,6EACC,QAAgB;EAEf,MAAM,WAAW,IAAI,QAAQ,UAAU,IAAI;EAE3C,MAAM,UAAU,SAAS,WAAW,OAAO,GAAG,WAAW,aAAa;EACtE,MAAM,UAAU,kBAAkB,QAAQ;AAC1C,SAAO,YAAY,WAAW,QAAQ,CAAC,+CAA+C,WAAW,QAAQ,CAAC,IAAI,WAAW,QAAQ,CAAC;GAErI;AAED,QAAO"}

package/docs/markform-apis.md

@@ -546,6 +546,59 @@ interface InjectHeaderIdsOptions {
 }
 ```
 
+## Rendering API
+
+Import from the render subpath for HTML rendering functions that produce the same output
+as `markform serve`:
+
+```typescript
+import {
+  renderViewContent,
+  renderSourceContent,
+  renderMarkdownContent,
+  renderYamlContent,
+  renderJsonContent,
+  renderFillRecordContent,
+  FILL_RECORD_STYLES,
+  FILL_RECORD_SCRIPTS,
+  escapeHtml,
+  formatDuration,
+  formatTokens,
+} from 'markform/render';
+```
+
+These functions produce HTML fragments (not full pages), so consumers can embed them in
+their own page shell with their own layout, CSS reset, and surrounding UI.
+
+### Content Renderers
+
+| Function | Input | Description |
+| --- | --- | --- |
+| `renderViewContent(form)` | `ParsedForm` | Render a form as a read-only HTML view |
+| `renderSourceContent(content)` | `string` | Render Jinja-style form source with syntax highlighting |
+| `renderMarkdownContent(content)` | `string` | Render markdown as HTML |
+| `renderYamlContent(content)` | `string` | Render YAML with syntax highlighting |
+| `renderJsonContent(content)` | `string` | Render JSON with syntax highlighting |
+| `renderFillRecordContent(record)` | `FillRecord` | Render a fill record as an interactive dashboard |
+
+### CSS and JavaScript Constants
+
+| Export | Description |
+| --- | --- |
+| `FILL_RECORD_STYLES` | `<style>` block with CSS for the fill record dashboard |
+| `FILL_RECORD_SCRIPTS` | JavaScript providing `frShowTip()`, `frHideTip()`, `frCopyYaml()` for fill record interactivity |
+
+Include `FILL_RECORD_STYLES` in your page `<head>` and `FILL_RECORD_SCRIPTS` in a
+`<script>` tag when using `renderFillRecordContent()`.
+
+### Utility Functions
+
+| Function | Description |
+| --- | --- |
+| `escapeHtml(str)` | Escape HTML special characters |
+| `formatDuration(ms)` | Format milliseconds as human-readable duration (e.g., `"1m 5s"`) |
+| `formatTokens(count)` | Format token counts with k suffix (e.g., `"1.5k"`) |
+
 ## Type Exports
 
 All Zod schemas and TypeScript types are exported from the main package: