@frontmcp/ui 0.5.0 → 0.6.0

package/layouts/base.d.ts

@@ -0,0 +1,86 @@
+/**
+ * Base Layout System
+ *
+ * Provides the foundation for all FrontMCP UI pages with:
+ * - Platform-aware rendering (OpenAI, Claude, etc.)
+ * - Theme integration
+ * - CDN resource management
+ * - Responsive layouts
+ */
+import { type PlatformCapabilities, type ThemeConfig, type DeepPartial } from '../theme';
+/**
+ * Page type determines the layout structure
+ */
+export type PageType = 'auth' | 'consent' | 'error' | 'loading' | 'success' | 'dashboard' | 'widget' | 'resource' | 'custom';
+/**
+ * Layout size/width options
+ */
+export type LayoutSize = 'xs' | 'sm' | 'md' | 'lg' | 'xl' | '2xl' | '3xl' | 'full';
+/**
+ * Background style options
+ */
+export type BackgroundStyle = 'solid' | 'gradient' | 'pattern' | 'none';
+/**
+ * Layout alignment options
+ */
+export type LayoutAlignment = 'center' | 'top' | 'start';
+/**
+ * Base layout configuration options
+ */
+export interface BaseLayoutOptions {
+    /** Page title (will be suffixed with branding) */
+    title: string;
+    /** Page type for layout structure */
+    pageType?: PageType;
+    /** Content width */
+    size?: LayoutSize;
+    /** Content alignment */
+    alignment?: LayoutAlignment;
+    /** Background style */
+    background?: BackgroundStyle;
+    /** Optional page description for meta tag */
+    description?: string;
+    /** Target platform capabilities */
+    platform?: PlatformCapabilities;
+    /** Theme configuration (deep partial - nested properties are also optional) */
+    theme?: DeepPartial<ThemeConfig>;
+    /** Include HTMX (default: based on platform) */
+    includeHtmx?: boolean;
+    /** Include Alpine.js (default: false) */
+    includeAlpine?: boolean;
+    /** Include Lucide icons (default: false) */
+    includeIcons?: boolean;
+    /** Additional head content */
+    headExtra?: string;
+    /** Additional body attributes */
+    bodyAttrs?: Record<string, string>;
+    /** Custom body classes */
+    bodyClass?: string;
+    /** Title suffix/branding */
+    titleSuffix?: string;
+    /** Favicon URL */
+    favicon?: string;
+    /** Open Graph meta tags */
+    og?: {
+        title?: string;
+        description?: string;
+        image?: string;
+        type?: string;
+    };
+}
+export { escapeHtml } from '../utils';
+/**
+ * Build the complete HTML document
+ *
+ * @param content - The page content (HTML string)
+ * @param options - Layout configuration options
+ * @returns Complete HTML document string
+ */
+export declare function baseLayout(content: string, options: BaseLayoutOptions): string;
+/**
+ * Create a layout builder with preset options.
+ * The returned function accepts optional options that extend/override the defaults.
+ * If defaults include `title`, the returned function's options are fully optional.
+ */
+export declare function createLayoutBuilder(defaults: Partial<BaseLayoutOptions>): (content: string, options?: Partial<BaseLayoutOptions>) => string;
+//# sourceMappingURL=base.d.ts.map

package/layouts/base.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../src/layouts/base.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EACL,KAAK,oBAAoB,EACzB,KAAK,WAAW,EAChB,KAAK,WAAW,EAWjB,MAAM,UAAU,CAAC;AAOlB;;GAEG;AACH,MAAM,MAAM,QAAQ,GAChB,MAAM,GACN,SAAS,GACT,OAAO,GACP,SAAS,GACT,SAAS,GACT,WAAW,GACX,QAAQ,GACR,UAAU,GACV,QAAQ,CAAC;AAEb;;GAEG;AACH,MAAM,MAAM,UAAU,GAClB,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,KAAK,GACL,KAAK,GACL,MAAM,CAAC;AAEX;;GAEG;AACH,MAAM,MAAM,eAAe,GACvB,OAAO,GACP,UAAU,GACV,SAAS,GACT,MAAM,CAAC;AAEX;;GAEG;AACH,MAAM,MAAM,eAAe,GACvB,QAAQ,GACR,KAAK,GACL,OAAO,CAAC;AAMZ;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,kDAAkD;IAClD,KAAK,EAAE,MAAM,CAAC;IAEd,qCAAqC;IACrC,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAEpB,oBAAoB;IACpB,IAAI,CAAC,EAAE,UAAU,CAAC;IAElB,wBAAwB;IACxB,SAAS,CAAC,EAAE,eAAe,CAAC;IAE5B,uBAAuB;IACvB,UAAU,CAAC,EAAE,eAAe,CAAC;IAE7B,6CAA6C;IAC7C,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,mCAAmC;IACnC,QAAQ,CAAC,EAAE,oBAAoB,CAAC;IAEhC,+EAA+E;IAC/E,KAAK,CAAC,EAAE,WAAW,CAAC,WAAW,CAAC,CAAC;IAEjC,gDAAgD;IAChD,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB,yCAAyC;IACzC,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB,4CAA4C;IAC5C,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB,8BAA8B;IAC9B,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,iCAAiC;IACjC,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEnC,0BAA0B;IAC1B,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,4BAA4B;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,kBAAkB;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,2BAA2B;IAC3B,EAAE,CAAC,EAAE;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,CAAC;CACH;AAOD,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AA8FtC;;;;;;GAMG;AACH,wBAAgB,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,iBAAiB,GAAG,MAAM,CAuG9E;AAMD;;;;GAIG;AACH,wBAAgB,mBAAmB,CACjC,QAAQ,EAAE,OAAO,CAAC,iBAAiB,CAAC,GACnC,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC,KAAK,MAAM,CAyBnE"}

package/layouts/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Layouts Module
+ *
+ * Provides base layouts and page-specific presets for FrontMCP UI.
+ */
+export { type PageType, type LayoutSize, type BackgroundStyle, type LayoutAlignment, type BaseLayoutOptions, baseLayout, createLayoutBuilder, escapeHtml, } from './base';
+export { type AuthLayoutOptions, type ConsentLayoutOptions, type ErrorLayoutOptions, type LoadingLayoutOptions, type SuccessLayoutOptions, type WidgetLayoutOptions, authLayout, consentLayout, errorLayout, loadingLayout, successLayout, widgetLayout, authLayoutBuilder, consentLayoutBuilder, errorLayoutBuilder, } from './presets';
+//# sourceMappingURL=index.d.ts.map

package/layouts/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/layouts/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EACL,KAAK,QAAQ,EACb,KAAK,UAAU,EACf,KAAK,eAAe,EACpB,KAAK,eAAe,EACpB,KAAK,iBAAiB,EACtB,UAAU,EACV,mBAAmB,EACnB,UAAU,GACX,MAAM,QAAQ,CAAC;AAGhB,OAAO,EACL,KAAK,iBAAiB,EACtB,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EACzB,KAAK,mBAAmB,EACxB,UAAU,EACV,aAAa,EACb,WAAW,EACX,aAAa,EACb,aAAa,EACb,YAAY,EACZ,iBAAiB,EACjB,oBAAoB,EACpB,kBAAkB,GACnB,MAAM,WAAW,CAAC"}