@frontmcp/uipack 0.6.1

package/renderers/html.renderer.d.ts

@@ -0,0 +1,123 @@
+/**
+ * HTML Renderer
+ *
+ * Handles plain HTML templates:
+ * - Static HTML strings
+ * - Template builder functions: (ctx) => string
+ * - Handlebars-enhanced templates: HTML with {{variable}} syntax
+ *
+ * This is the default fallback renderer with the lowest priority.
+ */
+import type { TemplateContext } from '../runtime/types';
+import type { PlatformCapabilities } from '../theme';
+import type { UIRenderer, TranspileResult, TranspileOptions, RenderOptions, RuntimeScripts } from './types';
+/**
+ * Template builder function type.
+ */
+type TemplateBuilderFn<In, Out> = (ctx: TemplateContext<In, Out>) => string;
+/**
+ * Types this renderer can handle.
+ */
+type HtmlTemplate<In = unknown, Out = unknown> = string | TemplateBuilderFn<In, Out>;
+/**
+ * Check if a template contains Handlebars syntax.
+ * Non-async version for canHandle check.
+ */
+declare function containsHandlebars(template: string): boolean;
+/**
+ * HTML Renderer Implementation.
+ *
+ * Handles:
+ * - Static HTML strings (passed through directly)
+ * - Template builder functions that return HTML strings
+ * - Handlebars-enhanced templates (detected by {{...}} syntax)
+ *
+ * When Handlebars syntax is detected, the template is processed
+ * with the HandlebarsRenderer for variable interpolation, conditionals,
+ * and loops.
+ *
+ * @example Static HTML
+ * ```typescript
+ * const template = '<div class="card">Hello World</div>';
+ * await htmlRenderer.render(template, context);
+ * ```
+ *
+ * @example Template function
+ * ```typescript
+ * const template = (ctx) => `<div>${ctx.helpers.escapeHtml(ctx.output.name)}</div>`;
+ * await htmlRenderer.render(template, context);
+ * ```
+ *
+ * @example Handlebars template
+ * ```typescript
+ * const template = `
+ *   <div class="card">
+ *     <h2>{{escapeHtml output.title}}</h2>
+ *     {{#if output.items}}
+ *       <ul>
+ *         {{#each output.items}}
+ *           <li>{{this.name}}</li>
+ *         {{/each}}
+ *       </ul>
+ *     {{/if}}
+ *   </div>
+ * `;
+ * await htmlRenderer.render(template, context);
+ * ```
+ */
+export declare class HtmlRenderer implements UIRenderer<HtmlTemplate> {
+    readonly type: "html";
+    readonly priority = 0;
+    /**
+     * Check if this renderer can handle the given template.
+     *
+     * Accepts:
+     * - Any string (assumed to be HTML, with or without Handlebars)
+     * - Functions that are template builders (not React components)
+     */
+    canHandle(template: unknown): template is HtmlTemplate;
+    /**
+     * Check if a template uses Handlebars syntax.
+     *
+     * @param template - Template string to check
+     * @returns true if template contains {{...}} syntax
+     */
+    usesHandlebars(template: string): boolean;
+    /**
+     * Transpile the template.
+     *
+     * For HTML templates, no transpilation is needed.
+     * This method returns a dummy result for consistency.
+     */
+    transpile(template: HtmlTemplate, _options?: TranspileOptions): Promise<TranspileResult>;
+    /**
+     * Render the template to HTML string.
+     *
+     * For static strings without Handlebars, returns the string directly.
+     * For strings with Handlebars syntax, processes with HandlebarsRenderer.
+     * For functions, calls the function with the context.
+     */
+    render<In, Out>(template: HtmlTemplate<In, Out>, context: TemplateContext<In, Out>, _options?: RenderOptions): Promise<string>;
+    /**
+     * Render Handlebars template with context.
+     */
+    private renderHandlebars;
+    /**
+     * Get runtime scripts for client-side functionality.
+     *
+     * HTML templates don't need additional runtime scripts.
+     */
+    getRuntimeScripts(_platform: PlatformCapabilities): RuntimeScripts;
+}
+/**
+ * Singleton instance of the HTML renderer.
+ */
+export declare const htmlRenderer: HtmlRenderer;
+/**
+ * Check if a template string contains Handlebars syntax.
+ *
+ * @param template - Template string
+ * @returns true if contains {{...}}
+ */
+export { containsHandlebars };
+//# sourceMappingURL=html.renderer.d.ts.map

package/renderers/html.renderer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"html.renderer.d.ts","sourceRoot":"","sources":["../../src/renderers/html.renderer.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAC;AACrD,OAAO,KAAK,EAAE,UAAU,EAAE,eAAe,EAAE,gBAAgB,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAI5G;;GAEG;AACH,KAAK,iBAAiB,CAAC,EAAE,EAAE,GAAG,IAAI,CAAC,GAAG,EAAE,eAAe,CAAC,EAAE,EAAE,GAAG,CAAC,KAAK,MAAM,CAAC;AAE5E;;GAEG;AACH,KAAK,YAAY,CAAC,EAAE,GAAG,OAAO,EAAE,GAAG,GAAG,OAAO,IAAI,MAAM,GAAG,iBAAiB,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;AA0CrF;;;GAGG;AACH,iBAAS,kBAAkB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAGrD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,qBAAa,YAAa,YAAW,UAAU,CAAC,YAAY,CAAC;IAC3D,QAAQ,CAAC,IAAI,EAAG,MAAM,CAAU;IAChC,QAAQ,CAAC,QAAQ,KAAK;IAEtB;;;;;;OAMG;IACH,SAAS,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI,YAAY;IActD;;;;;OAKG;IACH,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;IAIzC;;;;;OAKG;IACG,SAAS,CAAC,QAAQ,EAAE,YAAY,EAAE,QAAQ,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,eAAe,CAAC;IAW9F;;;;;;OAMG;IACG,MAAM,CAAC,EAAE,EAAE,GAAG,EAClB,QAAQ,EAAE,YAAY,CAAC,EAAE,EAAE,GAAG,CAAC,EAC/B,OAAO,EAAE,eAAe,CAAC,EAAE,EAAE,GAAG,CAAC,EACjC,QAAQ,CAAC,EAAE,aAAa,GACvB,OAAO,CAAC,MAAM,CAAC;IAwBlB;;OAEG;YACW,gBAAgB;IAmB9B;;;;OAIG;IACH,iBAAiB,CAAC,SAAS,EAAE,oBAAoB,GAAG,cAAc;CAMnE;AAED;;GAEG;AACH,eAAO,MAAM,YAAY,cAAqB,CAAC;AAE/C;;;;;GAKG;AACH,OAAO,EAAE,kBAAkB,EAAE,CAAC"}

package/renderers/index.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Renderer Module
+ *
+ * Multi-framework rendering system for Tool UI templates.
+ * Supports HTML, React, and MDX templates with auto-detection.
+ *
+ * @module @frontmcp/uipack/renderers
+ *
+ * @example Basic usage with auto-detection
+ * ```typescript
+ * import { rendererRegistry } from '@frontmcp/uipack/renderers';
+ *
+ * // HTML template
+ * const htmlTemplate = (ctx) => `<div>${ctx.output.name}</div>`;
+ * const result = await rendererRegistry.render(htmlTemplate, context);
+ * ```
+ *
+ * @example Register React renderer
+ * ```typescript
+ * import { rendererRegistry } from '@frontmcp/uipack/renderers';
+ * import { reactRenderer } from '@frontmcp/ui';
+ *
+ * rendererRegistry.register(reactRenderer);
+ *
+ * // Now React components are auto-detected
+ * const MyComponent = ({ output }) => <div>{output.name}</div>;
+ * const result = await rendererRegistry.render(MyComponent, context);
+ * ```
+ */
+export type { RendererType, UIRenderer, ToolUIProps, HydratedToolUIProps, TranspileResult, TranspileOptions, RenderOptions, RuntimeScripts, RenderResult, RendererRegistryOptions, DetectionResult, ReactComponentType, WrapperContext, ExtendedToolUIConfig, } from './types';
+export { TranspileCache, transpileCache, renderCache, type TranspileCacheOptions } from './cache';
+export { RendererRegistry, rendererRegistry } from './registry';
+export { HtmlRenderer, htmlRenderer } from './html.renderer';
+export { MdxRenderer, mdxRenderer, buildMdxHydrationScript } from './mdx.renderer';
+export { isReactComponent, isTemplateBuilderFunction, containsJsx, containsMdxSyntax, isPlainHtml, detectTemplateType, hashString, hashCombined, isHash, transpileJsx, isSwcAvailable, executeTranspiledCode, transpileAndExecute, } from './utils';
+//# sourceMappingURL=index.d.ts.map

package/renderers/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/renderers/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AAKH,YAAY,EACV,YAAY,EACZ,UAAU,EACV,WAAW,EACX,mBAAmB,EACnB,eAAe,EACf,gBAAgB,EAChB,aAAa,EACb,cAAc,EACd,YAAY,EACZ,uBAAuB,EACvB,eAAe,EACf,kBAAkB,EAClB,cAAc,EACd,oBAAoB,GACrB,MAAM,SAAS,CAAC;AAGjB,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,WAAW,EAAE,KAAK,qBAAqB,EAAE,MAAM,SAAS,CAAC;AAGlG,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAGhE,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAG7D,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,uBAAuB,EAAE,MAAM,gBAAgB,CAAC;AAKnF,OAAO,EACL,gBAAgB,EAChB,yBAAyB,EACzB,WAAW,EACX,iBAAiB,EACjB,WAAW,EACX,kBAAkB,EAClB,UAAU,EACV,YAAY,EACZ,MAAM,EACN,YAAY,EACZ,cAAc,EACd,qBAAqB,EACrB,mBAAmB,GACpB,MAAM,SAAS,CAAC"}