@hyper-elements/react 0.0.1 → 0.3.1

package/dist/pdf.d.ts

@@ -0,0 +1,29 @@
+import { Diagnostic } from '@hyper-elements/react';
+import { ReactElement } from 'react';
+
+interface PdfFont {
+    /** The family a template names in its fontFamily stacks ("Inter"). */
+    family: string;
+    /** The font file (TTF, OTF or WOFF; not WOFF2). */
+    src: Uint8Array | ArrayBuffer;
+    weight?: number;
+    style?: "normal" | "italic";
+}
+interface PdfOptions {
+    /** Font files, by the family the template names: PDF output loads none itself. */
+    fonts?: PdfFont[];
+    /** Image files (PNG or JPEG; an SVG's alt text is shown instead), by the URL the template gives: PDF output loads none itself. */
+    images?: Record<string, Uint8Array | ArrayBuffer>;
+    /** When the PDF says it was made (a fixed date by default, so a template makes the same file every time). */
+    date?: Date;
+}
+interface PdfResult {
+    /** The PDF file. */
+    pdf: Uint8Array;
+    /** Warnings and notes (errors are thrown). */
+    diagnostics: Diagnostic[];
+}
+/** A Document written as a PDF. Rejects with an `ElementsError` listing the problems if it has errors. */
+declare function renderPdf(element: ReactElement, options?: PdfOptions): Promise<PdfResult>;
+
+export { type PdfFont, type PdfOptions, type PdfResult, renderPdf };