@frontmcp/uipack 0.12.2 → 1.0.0-beta.2

package/component/loader.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Component Loader
+ *
+ * Resolves any UISource to a loadable component and generates
+ * mount scripts for the browser.
+ *
+ * @packageDocumentation
+ */
+import type { ImportResolver } from '../resolver/types';
+import type { UISource, ResolvedComponent } from './types';
+import { FRONTMCP_META_KEY } from './types';
+/**
+ * Resolve a UISource to a loadable component.
+ *
+ * - npm: uses ImportResolver to get CDN URL
+ * - file: reads file or resolves to served URL (inline mode defaults to true for small files)
+ * - import: passes URL through directly
+ * - function: executes with input/output, returns HTML string
+ */
+export declare function resolveUISource(source: UISource, options?: {
+    resolver?: ImportResolver;
+    input?: unknown;
+    output?: unknown;
+}): ResolvedComponent;
+/**
+ * Generate a mount script for module-based components.
+ *
+ * For non-MCP-aware components: passes output as props.
+ * For MCP-aware components: component reads bridge globals internally.
+ */
+export declare function generateMountScript(resolved: ResolvedComponent, propsMapping?: Record<string, string>): string;
+/**
+ * Well-known export for metadata auto-detection.
+ */
+export { FRONTMCP_META_KEY };
+//# sourceMappingURL=loader.d.ts.map

package/component/loader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"loader.d.ts","sourceRoot":"","sources":["../../src/component/loader.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAkB,MAAM,mBAAmB,CAAC;AAGxE,OAAO,KAAK,EACV,QAAQ,EAKR,iBAAiB,EAElB,MAAM,SAAS,CAAC;AACjB,OAAO,EAA+D,iBAAiB,EAAE,MAAM,SAAS,CAAC;AASzG;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAC7B,MAAM,EAAE,QAAQ,EAChB,OAAO,CAAC,EAAE;IACR,QAAQ,CAAC,EAAE,cAAc,CAAC;IAC1B,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB,GACA,iBAAiB,CAoBnB;AAiGD;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,iBAAiB,EAAE,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,MAAM,CA6B9G;AAmBD;;GAEG;AACH,OAAO,EAAE,iBAAiB,EAAE,CAAC"}

package/component/renderer.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Component Renderer
+ *
+ * Generates complete HTML shell for any UI component source.
+ * Combines the resolver, shell builder, and component loader.
+ *
+ * @packageDocumentation
+ */
+import type { ShellConfig, ShellResult } from '../shell/types';
+import type { UIConfig } from './types';
+/**
+ * Render a complete HTML shell for a UI component.
+ *
+ * @example
+ * ```typescript
+ * // NPM component
+ * const result = renderComponent(
+ *   { source: { npm: '@acme/dashboard-widget' } },
+ *   { toolName: 'my_tool', output: { data: [1,2,3] } }
+ * );
+ *
+ * // Function component
+ * const result = renderComponent(
+ *   { source: (input, output) => `<div>${output.message}</div>` },
+ *   { toolName: 'my_tool', output: { message: 'Hello' } }
+ * );
+ * ```
+ */
+export declare function renderComponent(config: UIConfig, shellConfig: ShellConfig): ShellResult;
+//# sourceMappingURL=renderer.d.ts.map

package/component/renderer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"renderer.d.ts","sourceRoot":"","sources":["../../src/component/renderer.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE/D,OAAO,KAAK,EAAE,QAAQ,EAAqB,MAAM,SAAS,CAAC;AAQ3D;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,QAAQ,EAAE,WAAW,EAAE,WAAW,GAAG,WAAW,CAyBvF"}

package/component/transpiler.d.ts

@@ -0,0 +1,49 @@
+/**
+ * React TSX/JSX Transpiler
+ *
+ * Uses esbuild to transpile React source files (TSX/JSX) into browser-ready
+ * ES module code with React.createElement calls. No React dependency needed
+ * at transpilation time — only syntax transformation.
+ *
+ * @packageDocumentation
+ */
+/**
+ * Transpile React TSX/JSX source code into browser-ready ES module code.
+ *
+ * Converts JSX syntax to React.createElement calls and strips TypeScript types.
+ * The output is suitable for embedding as an inline `<script type="module">`.
+ *
+ * @param source - Raw TSX/JSX source code
+ * @param filename - Optional filename hint for loader detection (e.g. 'component.tsx')
+ * @returns Transpiled JavaScript source code (ESM format)
+ */
+export declare function transpileReactSource(source: string, filename?: string): string;
+/**
+ * Bundle a FileSource .tsx/.jsx file with esbuild's buildSync.
+ *
+ * Resolves workspace dependencies (e.g. @frontmcp/ui) from local node_modules,
+ * inlines all non-React deps, and appends mount code so the output is a
+ * self-contained ES module that only depends on react/react-dom externally.
+ *
+ * @param source - Raw TSX/JSX source code
+ * @param filename - Filename hint for loader detection (e.g. 'widget.tsx')
+ * @param resolveDir - Directory for resolving bare imports (typically dirname of the source file)
+ * @param componentName - Name of the component to mount (extracted from source)
+ * @returns Bundled JavaScript source code
+ */
+export declare function bundleFileSource(source: string, filename: string, resolveDir: string, componentName: string): {
+    code: string;
+};
+/**
+ * Extract the default export name from transpiled source code.
+ *
+ * Supports patterns:
+ * - `export default function ComponentName`
+ * - `export default class ComponentName`
+ * - `export default ComponentName;`
+ *
+ * @param code - Transpiled JavaScript source code
+ * @returns The export name, or null if not found
+ */
+export declare function extractDefaultExportName(code: string): string | null;
+//# sourceMappingURL=transpiler.d.ts.map

package/component/transpiler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transpiler.d.ts","sourceRoot":"","sources":["../../src/component/transpiler.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAIH;;;;;;;;;GASG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAkB9E;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,gBAAgB,CAC9B,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,EAClB,aAAa,EAAE,MAAM,GACpB;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,CAuDlB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,wBAAwB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAUpE"}

package/component/types.d.ts

@@ -0,0 +1,82 @@
+/**
+ * Component Types
+ *
+ * Polymorphic UI component loading — 4 source modes:
+ * npm, file, import (URL), and inline function.
+ *
+ * @packageDocumentation
+ */
+/** Mode 1: NPM package — resolved via ImportResolver */
+export interface NpmSource {
+    npm: string;
+    exportName?: string;
+    version?: string;
+}
+/** Mode 2: File path — read at build time or served as URL */
+export interface FileSource {
+    file: string;
+    inline?: boolean;
+    /** Component export name (default: auto-detected from source or 'default') */
+    exportName?: string;
+    /** Override peer dependencies (default: ['react', 'react-dom'] for .tsx/.jsx) */
+    peerDependencies?: string[];
+}
+/** Mode 3: Direct URL import */
+export interface ImportSource {
+    import: string;
+    exportName?: string;
+}
+/** Mode 4: Inline template function */
+export type FunctionSource<In = unknown, Out = unknown> = (input: In, output: Out) => string;
+/** Union of all UI source types */
+export type UISource<In = unknown, Out = unknown> = NpmSource | FileSource | ImportSource | FunctionSource<In, Out>;
+export declare function isNpmSource(source: UISource): source is NpmSource;
+export declare function isFileSource(source: UISource): source is FileSource;
+export declare function isImportSource(source: UISource): source is ImportSource;
+export declare function isFunctionSource<In = unknown, Out = unknown>(source: UISource<In, Out>): source is FunctionSource<In, Out>;
+/** Full UI configuration on a tool */
+export interface UIConfig<In = unknown, Out = unknown> {
+    /** The UI source (one of the 4 modes) */
+    source: UISource<In, Out>;
+    /** Explicit props mapping from output paths (default: spread output as props) */
+    props?: Record<string, string>;
+    /** Shell configuration overrides */
+    withShell?: boolean;
+    /** Include bridge runtime */
+    includeBridge?: boolean;
+    /** Custom shell template (pre-resolved object or inline string). */
+    customShell?: import('../shell/custom-shell-types').ResolvedShellTemplate | string;
+}
+/** Auto-detected or declared metadata on a component module */
+export interface ComponentMeta {
+    /** Whether the component uses FrontMCP bridge internally */
+    mcpAware: boolean;
+    /** Rendering strategy */
+    renderer: 'react' | 'html' | 'auto';
+    /** Peer dependencies needed */
+    peerDependencies?: string[];
+}
+/** Well-known export name for component metadata auto-detection */
+export declare const FRONTMCP_META_KEY = "__frontmcp_meta";
+/** Result of resolving a UI source */
+export interface ResolvedComponent {
+    /** How the component should be loaded */
+    mode: 'module' | 'inline';
+    /** For module mode: the URL to import */
+    url?: string;
+    /** For inline mode: the HTML content */
+    html?: string;
+    /** Transpiled module source code (for inline module rendering of .tsx/.jsx files) */
+    code?: string;
+    /** External import specifiers found in the transpiled code */
+    imports?: string[];
+    /** Export name for the component (default: 'default') */
+    exportName: string;
+    /** Detected metadata */
+    meta: ComponentMeta;
+    /** Peer dependencies that need to be loaded */
+    peerDependencies: string[];
+    /** Whether the code is fully bundled with mount code included */
+    bundled?: boolean;
+}
+//# sourceMappingURL=types.d.ts.map

package/component/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/component/types.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAIH,wDAAwD;AACxD,MAAM,WAAW,SAAS;IACxB,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,8DAA8D;AAC9D,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,8EAA8E;IAC9E,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,iFAAiF;IACjF,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;CAC7B;AAED,gCAAgC;AAChC,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,uCAAuC;AACvC,MAAM,MAAM,cAAc,CAAC,EAAE,GAAG,OAAO,EAAE,GAAG,GAAG,OAAO,IAAI,CAAC,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,GAAG,KAAK,MAAM,CAAC;AAE7F,mCAAmC;AACnC,MAAM,MAAM,QAAQ,CAAC,EAAE,GAAG,OAAO,EAAE,GAAG,GAAG,OAAO,IAAI,SAAS,GAAG,UAAU,GAAG,YAAY,GAAG,cAAc,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;AAIpH,wBAAgB,WAAW,CAAC,MAAM,EAAE,QAAQ,GAAG,MAAM,IAAI,SAAS,CAEjE;AAED,wBAAgB,YAAY,CAAC,MAAM,EAAE,QAAQ,GAAG,MAAM,IAAI,UAAU,CAEnE;AAED,wBAAgB,cAAc,CAAC,MAAM,EAAE,QAAQ,GAAG,MAAM,IAAI,YAAY,CAEvE;AAED,wBAAgB,gBAAgB,CAAC,EAAE,GAAG,OAAO,EAAE,GAAG,GAAG,OAAO,EAC1D,MAAM,EAAE,QAAQ,CAAC,EAAE,EAAE,GAAG,CAAC,GACxB,MAAM,IAAI,cAAc,CAAC,EAAE,EAAE,GAAG,CAAC,CAEnC;AAID,sCAAsC;AACtC,MAAM,WAAW,QAAQ,CAAC,EAAE,GAAG,OAAO,EAAE,GAAG,GAAG,OAAO;IACnD,yCAAyC;IACzC,MAAM,EAAE,QAAQ,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;IAC1B,iFAAiF;IACjF,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC/B,oCAAoC;IACpC,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,6BAA6B;IAC7B,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,oEAAoE;IACpE,WAAW,CAAC,EAAE,OAAO,6BAA6B,EAAE,qBAAqB,GAAG,MAAM,CAAC;CACpF;AAED,+DAA+D;AAC/D,MAAM,WAAW,aAAa;IAC5B,4DAA4D;IAC5D,QAAQ,EAAE,OAAO,CAAC;IAClB,yBAAyB;IACzB,QAAQ,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC;IACpC,+BAA+B;IAC/B,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;CAC7B;AAED,mEAAmE;AACnE,eAAO,MAAM,iBAAiB,oBAAoB,CAAC;AAEnD,sCAAsC;AACtC,MAAM,WAAW,iBAAiB;IAChC,yCAAyC;IACzC,IAAI,EAAE,QAAQ,GAAG,QAAQ,CAAC;IAC1B,yCAAyC;IACzC,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,wCAAwC;IACxC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,qFAAqF;IACrF,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,8DAA8D;IAC9D,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,yDAAyD;IACzD,UAAU,EAAE,MAAM,CAAC;IACnB,wBAAwB;IACxB,IAAI,EAAE,aAAa,CAAC;IACpB,+CAA+C;IAC/C,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,iEAAiE;IACjE,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB"}