pretext-pdf 2.0.2 → 2.0.13

package/dist/schema/elements-text.d.ts

@@ -0,0 +1,782 @@
+export declare const paragraphSchema: {
+    readonly type: "object";
+    readonly required: readonly ["type", "text"];
+    readonly properties: {
+        readonly type: {
+            readonly type: "string";
+            readonly const: "paragraph";
+        };
+        readonly text: {
+            readonly type: "string";
+        };
+        readonly dir: {
+            readonly type: "string";
+            readonly enum: readonly ["ltr", "rtl", "auto"];
+        };
+        readonly fontSize: {
+            readonly type: "number";
+        };
+        readonly lineHeight: {
+            readonly type: "number";
+        };
+        readonly fontFamily: {
+            readonly type: "string";
+        };
+        readonly fontWeight: {
+            readonly type: "number";
+            readonly enum: readonly [400, 700];
+        };
+        readonly color: {
+            readonly type: "string";
+            readonly pattern: "^#[0-9A-Fa-f]{6}$";
+            readonly description: "6-digit hex color e.g. #FF0000";
+        };
+        readonly align: {
+            readonly type: "string";
+            readonly enum: readonly ["left", "center", "right", "justify"];
+        };
+        readonly bgColor: {
+            readonly type: "string";
+            readonly pattern: "^#[0-9A-Fa-f]{6}$";
+            readonly description: "6-digit hex color e.g. #FF0000";
+        };
+        readonly spaceAfter: {
+            readonly type: "number";
+            readonly description: "Space in points (pt)";
+        };
+        readonly spaceBefore: {
+            readonly type: "number";
+            readonly description: "Space in points (pt)";
+        };
+        readonly keepTogether: {
+            readonly type: "boolean";
+        };
+        readonly underline: {
+            readonly type: "boolean";
+        };
+        readonly strikethrough: {
+            readonly type: "boolean";
+        };
+        readonly url: {
+            readonly type: "string";
+            readonly format: "uri";
+        };
+        readonly letterSpacing: {
+            readonly type: "number";
+        };
+        readonly smallCaps: {
+            readonly type: "boolean";
+        };
+        readonly tabularNumbers: {
+            readonly type: "boolean";
+            readonly description: "Render digits at fixed slot width for aligned numeric columns.";
+        };
+        readonly columns: {
+            readonly type: "number";
+            readonly description: "Number of columns for multi-column layout. Default: 1";
+        };
+        readonly columnGap: {
+            readonly type: "number";
+            readonly description: "Gap between columns in pt. Default: 24";
+        };
+        readonly hyphenate: {
+            readonly type: "boolean";
+            readonly const: false;
+            readonly description: "Set to false to disable hyphenation for this element.";
+        };
+        readonly annotation: {
+            readonly type: "object";
+            readonly required: readonly ["contents"];
+            readonly properties: {
+                readonly contents: {
+                    readonly type: "string";
+                };
+                readonly author: {
+                    readonly type: "string";
+                };
+                readonly color: {
+                    readonly type: "string";
+                    readonly pattern: "^#[0-9A-Fa-f]{6}$";
+                    readonly description: "6-digit hex color e.g. #FF0000";
+                };
+                readonly open: {
+                    readonly type: "boolean";
+                };
+            };
+        };
+    };
+};
+export declare const headingSchema: {
+    readonly type: "object";
+    readonly required: readonly ["type", "level", "text"];
+    readonly properties: {
+        readonly type: {
+            readonly type: "string";
+            readonly const: "heading";
+        };
+        readonly level: {
+            readonly type: "number";
+            readonly enum: readonly [1, 2, 3, 4];
+        };
+        readonly text: {
+            readonly type: "string";
+        };
+        readonly dir: {
+            readonly type: "string";
+            readonly enum: readonly ["ltr", "rtl", "auto"];
+        };
+        readonly fontFamily: {
+            readonly type: "string";
+        };
+        readonly fontWeight: {
+            readonly type: "number";
+            readonly enum: readonly [400, 700];
+        };
+        readonly fontSize: {
+            readonly type: "number";
+        };
+        readonly lineHeight: {
+            readonly type: "number";
+        };
+        readonly align: {
+            readonly type: "string";
+            readonly enum: readonly ["left", "center", "right", "justify"];
+        };
+        readonly color: {
+            readonly type: "string";
+            readonly pattern: "^#[0-9A-Fa-f]{6}$";
+            readonly description: "6-digit hex color e.g. #FF0000";
+        };
+        readonly bgColor: {
+            readonly type: "string";
+            readonly pattern: "^#[0-9A-Fa-f]{6}$";
+            readonly description: "6-digit hex color e.g. #FF0000";
+        };
+        readonly spaceBefore: {
+            readonly type: "number";
+            readonly description: "Space in points (pt)";
+        };
+        readonly spaceAfter: {
+            readonly type: "number";
+            readonly description: "Space in points (pt)";
+        };
+        readonly keepTogether: {
+            readonly type: "boolean";
+        };
+        readonly underline: {
+            readonly type: "boolean";
+        };
+        readonly strikethrough: {
+            readonly type: "boolean";
+        };
+        readonly bookmark: {
+            readonly type: "boolean";
+            readonly const: false;
+        };
+        readonly anchor: {
+            readonly type: "string";
+        };
+        readonly url: {
+            readonly type: "string";
+            readonly format: "uri";
+        };
+        readonly letterSpacing: {
+            readonly type: "number";
+        };
+        readonly smallCaps: {
+            readonly type: "boolean";
+        };
+        readonly tabularNumbers: {
+            readonly type: "boolean";
+            readonly description: "Render digits at fixed slot width for aligned numeric columns.";
+        };
+        readonly hyphenate: {
+            readonly type: "boolean";
+            readonly const: false;
+            readonly description: "Set to false to disable hyphenation for this element.";
+        };
+        readonly annotation: {
+            readonly type: "object";
+            readonly required: readonly ["contents"];
+            readonly properties: {
+                readonly contents: {
+                    readonly type: "string";
+                };
+                readonly author: {
+                    readonly type: "string";
+                };
+                readonly color: {
+                    readonly type: "string";
+                    readonly pattern: "^#[0-9A-Fa-f]{6}$";
+                    readonly description: "6-digit hex color e.g. #FF0000";
+                };
+                readonly open: {
+                    readonly type: "boolean";
+                };
+            };
+        };
+    };
+};
+export declare const blockquoteSchema: {
+    readonly type: "object";
+    readonly required: readonly ["type", "text"];
+    readonly properties: {
+        readonly type: {
+            readonly type: "string";
+            readonly const: "blockquote";
+        };
+        readonly text: {
+            readonly type: "string";
+        };
+        readonly dir: {
+            readonly type: "string";
+            readonly enum: readonly ["ltr", "rtl", "auto"];
+        };
+        readonly borderColor: {
+            readonly type: "string";
+            readonly pattern: "^#[0-9A-Fa-f]{6}$";
+            readonly description: "6-digit hex color e.g. #FF0000";
+        };
+        readonly borderWidth: {
+            readonly type: "number";
+        };
+        readonly bgColor: {
+            readonly type: "string";
+            readonly pattern: "^#[0-9A-Fa-f]{6}$";
+            readonly description: "6-digit hex color e.g. #FF0000";
+        };
+        readonly color: {
+            readonly type: "string";
+            readonly pattern: "^#[0-9A-Fa-f]{6}$";
+            readonly description: "6-digit hex color e.g. #FF0000";
+        };
+        readonly fontFamily: {
+            readonly type: "string";
+        };
+        readonly fontWeight: {
+            readonly type: "number";
+            readonly enum: readonly [400, 700];
+        };
+        readonly fontStyle: {
+            readonly type: "string";
+            readonly enum: readonly ["normal", "italic"];
+        };
+        readonly fontSize: {
+            readonly type: "number";
+        };
+        readonly lineHeight: {
+            readonly type: "number";
+        };
+        readonly padding: {
+            readonly type: "number";
+            readonly description: "Shorthand for paddingH and paddingV.";
+        };
+        readonly paddingH: {
+            readonly type: "number";
+            readonly description: "Horizontal padding inside box in pt. Default: 16";
+        };
+        readonly paddingV: {
+            readonly type: "number";
+            readonly description: "Vertical padding inside box in pt. Default: 10";
+        };
+        readonly align: {
+            readonly type: "string";
+            readonly enum: readonly ["left", "center", "right", "justify"];
+        };
+        readonly spaceBefore: {
+            readonly type: "number";
+            readonly description: "Space in points (pt)";
+        };
+        readonly spaceAfter: {
+            readonly type: "number";
+            readonly description: "Space in points (pt)";
+        };
+        readonly keepTogether: {
+            readonly type: "boolean";
+        };
+        readonly underline: {
+            readonly type: "boolean";
+        };
+        readonly strikethrough: {
+            readonly type: "boolean";
+        };
+    };
+};
+export declare const codeSchema: {
+    readonly type: "object";
+    readonly required: readonly ["type", "text", "fontFamily"];
+    readonly properties: {
+        readonly type: {
+            readonly type: "string";
+            readonly const: "code";
+        };
+        readonly text: {
+            readonly type: "string";
+        };
+        readonly fontFamily: {
+            readonly type: "string";
+            readonly description: "Monospace font family (must be loaded in doc.fonts)";
+        };
+        readonly fontSize: {
+            readonly type: "number";
+        };
+        readonly lineHeight: {
+            readonly type: "number";
+        };
+        readonly bgColor: {
+            readonly type: "string";
+            readonly pattern: "^#[0-9A-Fa-f]{6}$";
+            readonly description: "6-digit hex color e.g. #FF0000";
+        };
+        readonly color: {
+            readonly type: "string";
+            readonly pattern: "^#[0-9A-Fa-f]{6}$";
+            readonly description: "6-digit hex color e.g. #FF0000";
+        };
+        readonly padding: {
+            readonly type: "number";
+        };
+        readonly spaceAfter: {
+            readonly type: "number";
+            readonly description: "Space in points (pt)";
+        };
+        readonly spaceBefore: {
+            readonly type: "number";
+            readonly description: "Space in points (pt)";
+        };
+        readonly keepTogether: {
+            readonly type: "boolean";
+        };
+        readonly language: {
+            readonly type: "string";
+            readonly description: "e.g. 'javascript', 'typescript', 'python'";
+        };
+        readonly dir: {
+            readonly type: "string";
+            readonly enum: readonly ["ltr", "rtl", "auto"];
+        };
+        readonly highlightTheme: {
+            readonly type: "object";
+            readonly description: "Custom syntax highlight colors (6-digit hex). Overrides default GitHub-light theme.";
+            readonly properties: {
+                readonly keyword: {
+                    readonly type: "string";
+                    readonly pattern: "^#[0-9A-Fa-f]{6}$";
+                    readonly description: "6-digit hex color e.g. #FF0000";
+                };
+                readonly string: {
+                    readonly type: "string";
+                    readonly pattern: "^#[0-9A-Fa-f]{6}$";
+                    readonly description: "6-digit hex color e.g. #FF0000";
+                };
+                readonly comment: {
+                    readonly type: "string";
+                    readonly pattern: "^#[0-9A-Fa-f]{6}$";
+                    readonly description: "6-digit hex color e.g. #FF0000";
+                };
+                readonly number: {
+                    readonly type: "string";
+                    readonly pattern: "^#[0-9A-Fa-f]{6}$";
+                    readonly description: "6-digit hex color e.g. #FF0000";
+                };
+                readonly function: {
+                    readonly type: "string";
+                    readonly pattern: "^#[0-9A-Fa-f]{6}$";
+                    readonly description: "6-digit hex color e.g. #FF0000";
+                };
+                readonly punctuation: {
+                    readonly type: "string";
+                    readonly pattern: "^#[0-9A-Fa-f]{6}$";
+                    readonly description: "6-digit hex color e.g. #FF0000";
+                };
+                readonly type: {
+                    readonly type: "string";
+                    readonly pattern: "^#[0-9A-Fa-f]{6}$";
+                    readonly description: "6-digit hex color e.g. #FF0000";
+                };
+                readonly built_in: {
+                    readonly type: "string";
+                    readonly pattern: "^#[0-9A-Fa-f]{6}$";
+                    readonly description: "6-digit hex color e.g. #FF0000";
+                };
+                readonly literal: {
+                    readonly type: "string";
+                    readonly pattern: "^#[0-9A-Fa-f]{6}$";
+                    readonly description: "6-digit hex color e.g. #FF0000";
+                };
+            };
+        };
+    };
+};
+export declare const calloutSchema: {
+    readonly type: "object";
+    readonly required: readonly ["type", "content"];
+    readonly properties: {
+        readonly type: {
+            readonly type: "string";
+            readonly const: "callout";
+        };
+        readonly content: {
+            readonly type: "string";
+        };
+        readonly style: {
+            readonly type: "string";
+            readonly enum: readonly ["info", "warning", "tip", "note"];
+        };
+        readonly title: {
+            readonly type: "string";
+        };
+        readonly backgroundColor: {
+            readonly type: "string";
+            readonly pattern: "^#[0-9A-Fa-f]{6}$";
+            readonly description: "6-digit hex color e.g. #FF0000";
+        };
+        readonly borderColor: {
+            readonly type: "string";
+            readonly pattern: "^#[0-9A-Fa-f]{6}$";
+            readonly description: "6-digit hex color e.g. #FF0000";
+        };
+        readonly color: {
+            readonly type: "string";
+            readonly pattern: "^#[0-9A-Fa-f]{6}$";
+            readonly description: "6-digit hex color e.g. #FF0000";
+        };
+        readonly titleColor: {
+            readonly type: "string";
+            readonly pattern: "^#[0-9A-Fa-f]{6}$";
+            readonly description: "6-digit hex color e.g. #FF0000";
+        };
+        readonly fontFamily: {
+            readonly type: "string";
+        };
+        readonly fontWeight: {
+            readonly type: "number";
+            readonly enum: readonly [400, 700];
+        };
+        readonly fontSize: {
+            readonly type: "number";
+        };
+        readonly lineHeight: {
+            readonly type: "number";
+        };
+        readonly padding: {
+            readonly type: "number";
+            readonly description: "Shorthand for paddingH and paddingV. Default: 12";
+        };
+        readonly paddingH: {
+            readonly type: "number";
+            readonly description: "Horizontal padding inside box in pt. Default: 16";
+        };
+        readonly paddingV: {
+            readonly type: "number";
+            readonly description: "Vertical padding inside box in pt. Default: 10";
+        };
+        readonly spaceBefore: {
+            readonly type: "number";
+            readonly description: "Space in points (pt)";
+        };
+        readonly spaceAfter: {
+            readonly type: "number";
+            readonly description: "Space in points (pt)";
+        };
+        readonly keepTogether: {
+            readonly type: "boolean";
+        };
+        readonly dir: {
+            readonly type: "string";
+            readonly enum: readonly ["ltr", "rtl", "auto"];
+        };
+    };
+};
+export declare const richParagraphSchema: {
+    readonly type: "object";
+    readonly required: readonly ["type", "spans"];
+    readonly properties: {
+        readonly type: {
+            readonly type: "string";
+            readonly const: "rich-paragraph";
+        };
+        readonly spans: {
+            readonly type: "array";
+            readonly items: {
+                readonly type: "object";
+                readonly required: readonly ["text"];
+                readonly properties: {
+                    readonly text: {
+                        readonly type: "string";
+                    };
+                    readonly dir: {
+                        readonly type: "string";
+                        readonly enum: readonly ["ltr", "rtl", "auto"];
+                    };
+                    readonly fontFamily: {
+                        readonly type: "string";
+                    };
+                    readonly fontWeight: {
+                        readonly type: "number";
+                        readonly enum: readonly [400, 700];
+                    };
+                    readonly fontStyle: {
+                        readonly type: "string";
+                        readonly enum: readonly ["normal", "italic"];
+                    };
+                    readonly color: {
+                        readonly type: "string";
+                        readonly pattern: "^#[0-9A-Fa-f]{6}$";
+                        readonly description: "6-digit hex color e.g. #FF0000";
+                    };
+                    readonly fontSize: {
+                        readonly type: "number";
+                    };
+                    readonly underline: {
+                        readonly type: "boolean";
+                    };
+                    readonly strikethrough: {
+                        readonly type: "boolean";
+                    };
+                    readonly url: {
+                        readonly type: "string";
+                    };
+                    readonly href: {
+                        readonly type: "string";
+                    };
+                    readonly verticalAlign: {
+                        readonly type: "string";
+                        readonly enum: readonly ["superscript", "subscript"];
+                    };
+                    readonly smallCaps: {
+                        readonly type: "boolean";
+                    };
+                    readonly letterSpacing: {
+                        readonly type: "number";
+                    };
+                    readonly footnoteRef: {
+                        readonly type: "string";
+                    };
+                };
+            };
+        };
+        readonly dir: {
+            readonly type: "string";
+            readonly enum: readonly ["ltr", "rtl", "auto"];
+        };
+        readonly fontSize: {
+            readonly type: "number";
+        };
+        readonly lineHeight: {
+            readonly type: "number";
+        };
+        readonly align: {
+            readonly type: "string";
+            readonly enum: readonly ["left", "center", "right", "justify"];
+        };
+        readonly bgColor: {
+            readonly type: "string";
+            readonly pattern: "^#[0-9A-Fa-f]{6}$";
+            readonly description: "6-digit hex color e.g. #FF0000";
+        };
+        readonly spaceBefore: {
+            readonly type: "number";
+            readonly description: "Space in points (pt)";
+        };
+        readonly spaceAfter: {
+            readonly type: "number";
+            readonly description: "Space in points (pt)";
+        };
+        readonly keepTogether: {
+            readonly type: "boolean";
+        };
+        readonly letterSpacing: {
+            readonly type: "number";
+        };
+        readonly smallCaps: {
+            readonly type: "boolean";
+        };
+        readonly tabularNumbers: {
+            readonly type: "boolean";
+            readonly description: "Render digits at fixed slot width for aligned numeric columns.";
+        };
+        readonly columns: {
+            readonly type: "number";
+            readonly description: "Number of columns for multi-column layout. Default: 1";
+        };
+        readonly columnGap: {
+            readonly type: "number";
+            readonly description: "Gap between columns in pt. Default: 24";
+        };
+    };
+};
+export declare const listSchema: {
+    readonly type: "object";
+    readonly required: readonly ["type", "style", "items"];
+    readonly properties: {
+        readonly type: {
+            readonly type: "string";
+            readonly const: "list";
+        };
+        readonly style: {
+            readonly type: "string";
+            readonly enum: readonly ["ordered", "unordered"];
+        };
+        readonly items: {
+            readonly type: "array";
+            readonly items: {
+                readonly type: "object";
+                readonly required: readonly ["text"];
+                readonly properties: {
+                    readonly text: {
+                        readonly type: "string";
+                    };
+                    readonly dir: {
+                        readonly type: "string";
+                        readonly enum: readonly ["ltr", "rtl", "auto"];
+                    };
+                    readonly fontWeight: {
+                        readonly type: "number";
+                        readonly enum: readonly [400, 700];
+                    };
+                    readonly items: {
+                        readonly type: "array";
+                        readonly description: "Nested list items (up to 2 levels)";
+                        readonly items: {
+                            readonly type: "object";
+                            readonly required: readonly ["text"];
+                            readonly properties: {
+                                readonly text: {
+                                    readonly type: "string";
+                                };
+                                readonly dir: {
+                                    readonly type: "string";
+                                    readonly enum: readonly ["ltr", "rtl", "auto"];
+                                };
+                                readonly fontWeight: {
+                                    readonly type: "number";
+                                    readonly enum: readonly [400, 700];
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        readonly marker: {
+            readonly type: "string";
+        };
+        readonly indent: {
+            readonly type: "number";
+        };
+        readonly markerWidth: {
+            readonly type: "number";
+            readonly description: "Width reserved for marker column in pt. Default: 20";
+        };
+        readonly fontSize: {
+            readonly type: "number";
+        };
+        readonly lineHeight: {
+            readonly type: "number";
+        };
+        readonly itemSpaceAfter: {
+            readonly type: "number";
+            readonly description: "Space between list items in pt. Default: 4";
+        };
+        readonly nestedNumberingStyle: {
+            readonly type: "string";
+            readonly enum: readonly ["continue", "restart"];
+            readonly description: "How nested ordered counters behave. Default: continue";
+        };
+        readonly color: {
+            readonly type: "string";
+            readonly pattern: "^#[0-9A-Fa-f]{6}$";
+            readonly description: "6-digit hex color e.g. #FF0000";
+        };
+        readonly spaceAfter: {
+            readonly type: "number";
+            readonly description: "Space in points (pt)";
+        };
+        readonly spaceBefore: {
+            readonly type: "number";
+            readonly description: "Space in points (pt)";
+        };
+    };
+};
+export declare const tocSchema: {
+    readonly type: "object";
+    readonly required: readonly ["type"];
+    readonly properties: {
+        readonly type: {
+            readonly type: "string";
+            readonly const: "toc";
+        };
+        readonly title: {
+            readonly type: "string";
+        };
+        readonly showTitle: {
+            readonly type: "boolean";
+        };
+        readonly minLevel: {
+            readonly type: "number";
+            readonly enum: readonly [1, 2, 3, 4];
+        };
+        readonly maxLevel: {
+            readonly type: "number";
+            readonly enum: readonly [1, 2, 3, 4];
+        };
+        readonly fontSize: {
+            readonly type: "number";
+        };
+        readonly titleFontSize: {
+            readonly type: "number";
+            readonly description: "Font size for TOC title. Default: fontSize + 4";
+        };
+        readonly levelIndent: {
+            readonly type: "number";
+            readonly description: "Indentation per level in pt. Default: 16";
+        };
+        readonly leader: {
+            readonly type: "string";
+            readonly description: "Leader character between entry and page number. Default: .";
+        };
+        readonly entrySpacing: {
+            readonly type: "number";
+            readonly description: "Space after each entry line in pt. Default: 4";
+        };
+        readonly fontFamily: {
+            readonly type: "string";
+        };
+        readonly spaceBefore: {
+            readonly type: "number";
+            readonly description: "Space in points (pt)";
+        };
+        readonly spaceAfter: {
+            readonly type: "number";
+            readonly description: "Space in points (pt)";
+        };
+    };
+};
+export declare const footnoteDefSchema: {
+    readonly type: "object";
+    readonly required: readonly ["type", "id", "text"];
+    readonly properties: {
+        readonly type: {
+            readonly type: "string";
+            readonly const: "footnote-def";
+        };
+        readonly id: {
+            readonly type: "string";
+        };
+        readonly text: {
+            readonly type: "string";
+        };
+        readonly fontSize: {
+            readonly type: "number";
+        };
+        readonly fontFamily: {
+            readonly type: "string";
+        };
+        readonly spaceAfter: {
+            readonly type: "number";
+            readonly description: "Space in points (pt)";
+        };
+    };
+};
+//# sourceMappingURL=elements-text.d.ts.map