@bambamboole/pdf-ua-template-builder 0.3.1 → 0.4.0

package/dist/api/pdfUaApi.d.ts

@@ -1,10 +1,20 @@
+import { FileAttachment } from '../types/generated/template';
 import { RenderOptions, Template, TemplateData, TemplateSchemaResponse } from '../types/template';
 interface RenderTemplateRequest {
     template: Template;
     data?: TemplateData;
     options?: RenderOptions;
 }
+export interface ConvertHtmlRequest {
+    /** Raw HTML document to convert to a PDF/UA document. */
+    html: string;
+    /** Base URL used to resolve relative asset references in the HTML. */
+    baseUrl?: string;
+    /** Files to embed in the produced PDF/A-3 document. */
+    attachments?: FileAttachment[];
+}
 export declare function resolveDefaultApiUrl(configuredApiUrl?: string): string;
 export declare function fetchTemplateSchema(baseUrl: string): Promise<TemplateSchemaResponse>;
 export declare function renderTemplatePdf(baseUrl: string, request: RenderTemplateRequest): Promise<Blob>;
+export declare function renderHtmlPdf(baseUrl: string, request: ConvertHtmlRequest): Promise<Blob>;
 export {};

package/dist/html-editor/HtmlCodeEditor.d.ts

@@ -0,0 +1,4 @@
+export interface HtmlCodeEditorProps {
+    className?: string;
+}
+export declare function HtmlCodeEditor({ className }?: HtmlCodeEditorProps): import("react/jsx-runtime").JSX.Element;

package/dist/html-editor/HtmlEditor.d.ts

@@ -0,0 +1,22 @@
+export interface HtmlEditorProps {
+    /** Base URL of a running pdf-ua-api instance. Defaults to "" (relative URLs / proxy). */
+    apiUrl?: string;
+    /** Base URL used to resolve relative asset references in the HTML. */
+    baseUrl?: string;
+    /** HTML seeded into the editor on first render. Defaults to a small accessible document. */
+    initialHtml?: string;
+    /** Fires on every edit with the current HTML text. */
+    onChange?: (html: string) => void;
+    /** Fires after a successful render with the produced PDF blob. */
+    onRendered?: (pdf: Blob) => void;
+    /** Optional className appended to the root element. */
+    className?: string;
+}
+/**
+ * All-in-one preset: a raw-HTML editor and a rendered-PDF preview side by side.
+ * The preview is produced by the backend `POST /convert` (HTML → PDF/UA) endpoint.
+ *
+ * For custom layouts, compose directly with `HtmlEditorProvider`, `HtmlCodeEditor`,
+ * and `HtmlPreview`.
+ */
+export declare function HtmlEditor({ apiUrl, baseUrl, initialHtml, onChange, onRendered, className, }?: HtmlEditorProps): import("react/jsx-runtime").JSX.Element;

package/dist/html-editor/HtmlEditorContext.d.ts

@@ -0,0 +1,25 @@
+import { ReactNode } from 'react';
+export interface HtmlEditorProviderProps {
+    /** Base URL of a running pdf-ua-api instance. Defaults to "" (relative URLs / proxy). */
+    apiUrl?: string;
+    /** Base URL used to resolve relative asset references in the HTML. */
+    baseUrl?: string;
+    /** HTML seeded into the editor on first render. Defaults to a small accessible document. */
+    initialHtml?: string;
+    /** Fires on every edit with the current HTML text. */
+    onChange?: (html: string) => void;
+    /** Fires after a successful render with the produced PDF blob. */
+    onRendered?: (pdf: Blob) => void;
+    children: ReactNode;
+}
+export interface HtmlEditorContextValue {
+    html: string;
+    setHtml: (html: string) => void;
+    pdfUrl: string | null;
+    pdfLoading: boolean;
+    error: string | null;
+    renderPdf: () => void;
+    renderDisabled: boolean;
+}
+export declare function useHtmlEditor(): HtmlEditorContextValue;
+export declare function HtmlEditorProvider({ apiUrl: apiUrlProp, baseUrl, initialHtml, onChange, onRendered, children, }: HtmlEditorProviderProps): import("react/jsx-runtime").JSX.Element;

package/dist/html-editor/HtmlPreview.d.ts

@@ -0,0 +1,4 @@
+export interface HtmlPreviewProps {
+    className?: string;
+}
+export declare function HtmlPreview({ className }?: HtmlPreviewProps): import("react/jsx-runtime").JSX.Element;

package/dist/html-editor/defaultHtml.d.ts

@@ -0,0 +1,2 @@
+/** Seed document for the HTML editor: a small, accessible page that renders cleanly to PDF/UA. */
+export declare const DEFAULT_HTML = "<!DOCTYPE html>\n<html lang=\"en\">\n  <head>\n    <meta charset=\"utf-8\" />\n    <title>Untitled document</title>\n    <style>\n      body {\n        font-family: system-ui, sans-serif;\n        margin: 2rem;\n        color: #1a1a1a;\n        line-height: 1.5;\n      }\n      h1 {\n        font-size: 1.75rem;\n        margin-bottom: 0.5rem;\n      }\n    </style>\n  </head>\n  <body>\n    <h1>Hello, PDF/UA</h1>\n    <p>Edit this HTML and render it to preview the accessible PDF.</p>\n  </body>\n</html>\n";

package/dist/html-editor/useHtmlPreview.d.ts

@@ -0,0 +1,13 @@
+interface UseHtmlPreviewOptions {
+    apiUrl: string;
+    baseUrl?: string;
+    onRendered?: (pdf: Blob) => void;
+}
+interface HtmlPreview {
+    pdfUrl: string | null;
+    loading: boolean;
+    error: string | null;
+    render: (html: string) => Promise<void>;
+}
+export declare function useHtmlPreview({ apiUrl, baseUrl, onRendered }: UseHtmlPreviewOptions): HtmlPreview;
+export {};

package/dist/index.d.ts

@@ -18,6 +18,15 @@ export { CodeEditor } from './editor/CodeEditor';
 export type { CodeEditorProps } from './editor/CodeEditor';
 export { TemplateEditorProvider, useTemplateEditor, } from './editor/TemplateEditorContext';
 export type { TemplateEditorProviderProps, TemplateEditorContextValue, } from './editor/TemplateEditorContext';
-export { fetchTemplateSchema, renderTemplatePdf, resolveDefaultApiUrl } from './api/pdfUaApi';
+export { HtmlEditor } from './html-editor/HtmlEditor';
+export type { HtmlEditorProps } from './html-editor/HtmlEditor';
+export { HtmlCodeEditor } from './html-editor/HtmlCodeEditor';
+export type { HtmlCodeEditorProps } from './html-editor/HtmlCodeEditor';
+export { HtmlPreview } from './html-editor/HtmlPreview';
+export type { HtmlPreviewProps } from './html-editor/HtmlPreview';
+export { HtmlEditorProvider, useHtmlEditor } from './html-editor/HtmlEditorContext';
+export type { HtmlEditorProviderProps, HtmlEditorContextValue, } from './html-editor/HtmlEditorContext';
+export { fetchTemplateSchema, renderTemplatePdf, renderHtmlPdf, resolveDefaultApiUrl, } from './api/pdfUaApi';
+export type { ConvertHtmlRequest } from './api/pdfUaApi';
 export type { TemplateData, TemplateSchemaResponse } from './types/template';
 export type { Align, Block, HeadingBlock, ImageBlock, KeyValueBlock, Orientation, PageConfig, PageFormat, PageSize, Row, SpacerBlock, TableBlock, Template, TextBlock, } from './types/generated/template';