|
| 1 | +/** |
| 2 | + * Azoth JSX Type Definitions |
| 3 | + * |
| 4 | + * Azoth JSX produces "DOM literals" - actual DOM elements, not virtual DOM. |
| 5 | + * `<p>hello</p>` yields an HTMLParagraphElement, not a React component. |
| 6 | + * |
| 7 | + * These type definitions leverage TypeScript's built-in lib.dom.d.ts types |
| 8 | + * to provide accurate intellisense for Azoth JSX. |
| 9 | + */ |
| 10 | + |
| 11 | +// Children can be strings, numbers, nodes, or arrays of these |
| 12 | +type DOMChild = |
| 13 | + | string |
| 14 | + | number |
| 15 | + | boolean |
| 16 | + | Node |
| 17 | + | null |
| 18 | + | undefined |
| 19 | + | DOMChild[]; |
| 20 | + |
| 21 | +// Properties to exclude from element attributes |
| 22 | +type ExcludedProps = "children"; |
| 23 | + |
| 24 | +// Get writable properties from an element, excluding functions and specific props |
| 25 | +type WritableElementProps<T> = { |
| 26 | + [ |
| 27 | + K in keyof T as K extends ExcludedProps ? never |
| 28 | + : K extends string ? (T[K] extends Function ? never : K) |
| 29 | + : never |
| 30 | + ]?: T[K]; |
| 31 | +}; |
| 32 | + |
| 33 | +// HTML attributes that differ from DOM properties |
| 34 | +// Azoth supports both HTML attributes (class, for) and DOM properties (className, htmlFor) |
| 35 | +type HTMLAttributeAliases = { |
| 36 | + class?: string; // HTML attribute (alias for className) |
| 37 | + for?: string; // HTML attribute (alias for htmlFor) |
| 38 | +}; |
| 39 | + |
| 40 | +// Combined props for an intrinsic element |
| 41 | +type IntrinsicElementProps<T> = |
| 42 | + & WritableElementProps<T> |
| 43 | + & HTMLAttributeAliases |
| 44 | + & { |
| 45 | + children?: DOMChild; |
| 46 | + }; |
| 47 | + |
| 48 | +declare global { |
| 49 | + namespace JSX { |
| 50 | + // JSX expressions evaluate to DOM Nodes |
| 51 | + // Specific element types require assertion: <p>hi</p> as HTMLParagraphElement |
| 52 | + // Future: TypeScript contribution for per-tag return types |
| 53 | + type Element = Node; |
| 54 | + |
| 55 | + // Children attribute |
| 56 | + interface ElementChildrenAttribute { |
| 57 | + children: {}; |
| 58 | + } |
| 59 | + |
| 60 | + // Intrinsic elements: HTML + SVG |
| 61 | + interface IntrinsicElements { |
| 62 | + // HTML Elements |
| 63 | + a: IntrinsicElementProps<HTMLAnchorElement>; |
| 64 | + abbr: IntrinsicElementProps<HTMLElement>; |
| 65 | + address: IntrinsicElementProps<HTMLElement>; |
| 66 | + area: IntrinsicElementProps<HTMLAreaElement>; |
| 67 | + article: IntrinsicElementProps<HTMLElement>; |
| 68 | + aside: IntrinsicElementProps<HTMLElement>; |
| 69 | + audio: IntrinsicElementProps<HTMLAudioElement>; |
| 70 | + b: IntrinsicElementProps<HTMLElement>; |
| 71 | + base: IntrinsicElementProps<HTMLBaseElement>; |
| 72 | + bdi: IntrinsicElementProps<HTMLElement>; |
| 73 | + bdo: IntrinsicElementProps<HTMLElement>; |
| 74 | + blockquote: IntrinsicElementProps<HTMLQuoteElement>; |
| 75 | + body: IntrinsicElementProps<HTMLBodyElement>; |
| 76 | + br: IntrinsicElementProps<HTMLBRElement>; |
| 77 | + button: IntrinsicElementProps<HTMLButtonElement>; |
| 78 | + canvas: IntrinsicElementProps<HTMLCanvasElement>; |
| 79 | + caption: IntrinsicElementProps<HTMLTableCaptionElement>; |
| 80 | + cite: IntrinsicElementProps<HTMLElement>; |
| 81 | + code: IntrinsicElementProps<HTMLElement>; |
| 82 | + col: IntrinsicElementProps<HTMLTableColElement>; |
| 83 | + colgroup: IntrinsicElementProps<HTMLTableColElement>; |
| 84 | + data: IntrinsicElementProps<HTMLDataElement>; |
| 85 | + datalist: IntrinsicElementProps<HTMLDataListElement>; |
| 86 | + dd: IntrinsicElementProps<HTMLElement>; |
| 87 | + del: IntrinsicElementProps<HTMLModElement>; |
| 88 | + details: IntrinsicElementProps<HTMLDetailsElement>; |
| 89 | + dfn: IntrinsicElementProps<HTMLElement>; |
| 90 | + dialog: IntrinsicElementProps<HTMLDialogElement>; |
| 91 | + div: IntrinsicElementProps<HTMLDivElement>; |
| 92 | + dl: IntrinsicElementProps<HTMLDListElement>; |
| 93 | + dt: IntrinsicElementProps<HTMLElement>; |
| 94 | + em: IntrinsicElementProps<HTMLElement>; |
| 95 | + embed: IntrinsicElementProps<HTMLEmbedElement>; |
| 96 | + fieldset: IntrinsicElementProps<HTMLFieldSetElement>; |
| 97 | + figcaption: IntrinsicElementProps<HTMLElement>; |
| 98 | + figure: IntrinsicElementProps<HTMLElement>; |
| 99 | + footer: IntrinsicElementProps<HTMLElement>; |
| 100 | + form: IntrinsicElementProps<HTMLFormElement>; |
| 101 | + h1: IntrinsicElementProps<HTMLHeadingElement>; |
| 102 | + h2: IntrinsicElementProps<HTMLHeadingElement>; |
| 103 | + h3: IntrinsicElementProps<HTMLHeadingElement>; |
| 104 | + h4: IntrinsicElementProps<HTMLHeadingElement>; |
| 105 | + h5: IntrinsicElementProps<HTMLHeadingElement>; |
| 106 | + h6: IntrinsicElementProps<HTMLHeadingElement>; |
| 107 | + head: IntrinsicElementProps<HTMLHeadElement>; |
| 108 | + header: IntrinsicElementProps<HTMLElement>; |
| 109 | + hgroup: IntrinsicElementProps<HTMLElement>; |
| 110 | + hr: IntrinsicElementProps<HTMLHRElement>; |
| 111 | + html: IntrinsicElementProps<HTMLHtmlElement>; |
| 112 | + i: IntrinsicElementProps<HTMLElement>; |
| 113 | + iframe: IntrinsicElementProps<HTMLIFrameElement>; |
| 114 | + img: IntrinsicElementProps<HTMLImageElement>; |
| 115 | + input: IntrinsicElementProps<HTMLInputElement>; |
| 116 | + ins: IntrinsicElementProps<HTMLModElement>; |
| 117 | + kbd: IntrinsicElementProps<HTMLElement>; |
| 118 | + label: IntrinsicElementProps<HTMLLabelElement>; |
| 119 | + legend: IntrinsicElementProps<HTMLLegendElement>; |
| 120 | + li: IntrinsicElementProps<HTMLLIElement>; |
| 121 | + link: IntrinsicElementProps<HTMLLinkElement>; |
| 122 | + main: IntrinsicElementProps<HTMLElement>; |
| 123 | + map: IntrinsicElementProps<HTMLMapElement>; |
| 124 | + mark: IntrinsicElementProps<HTMLElement>; |
| 125 | + menu: IntrinsicElementProps<HTMLMenuElement>; |
| 126 | + meta: IntrinsicElementProps<HTMLMetaElement>; |
| 127 | + meter: IntrinsicElementProps<HTMLMeterElement>; |
| 128 | + nav: IntrinsicElementProps<HTMLElement>; |
| 129 | + noscript: IntrinsicElementProps<HTMLElement>; |
| 130 | + object: IntrinsicElementProps<HTMLObjectElement>; |
| 131 | + ol: IntrinsicElementProps<HTMLOListElement>; |
| 132 | + optgroup: IntrinsicElementProps<HTMLOptGroupElement>; |
| 133 | + option: IntrinsicElementProps<HTMLOptionElement>; |
| 134 | + output: IntrinsicElementProps<HTMLOutputElement>; |
| 135 | + p: IntrinsicElementProps<HTMLParagraphElement>; |
| 136 | + picture: IntrinsicElementProps<HTMLPictureElement>; |
| 137 | + pre: IntrinsicElementProps<HTMLPreElement>; |
| 138 | + progress: IntrinsicElementProps<HTMLProgressElement>; |
| 139 | + q: IntrinsicElementProps<HTMLQuoteElement>; |
| 140 | + rp: IntrinsicElementProps<HTMLElement>; |
| 141 | + rt: IntrinsicElementProps<HTMLElement>; |
| 142 | + ruby: IntrinsicElementProps<HTMLElement>; |
| 143 | + s: IntrinsicElementProps<HTMLElement>; |
| 144 | + samp: IntrinsicElementProps<HTMLElement>; |
| 145 | + script: IntrinsicElementProps<HTMLScriptElement>; |
| 146 | + section: IntrinsicElementProps<HTMLElement>; |
| 147 | + select: IntrinsicElementProps<HTMLSelectElement>; |
| 148 | + slot: IntrinsicElementProps<HTMLSlotElement>; |
| 149 | + small: IntrinsicElementProps<HTMLElement>; |
| 150 | + source: IntrinsicElementProps<HTMLSourceElement>; |
| 151 | + span: IntrinsicElementProps<HTMLSpanElement>; |
| 152 | + strong: IntrinsicElementProps<HTMLElement>; |
| 153 | + style: IntrinsicElementProps<HTMLStyleElement>; |
| 154 | + sub: IntrinsicElementProps<HTMLElement>; |
| 155 | + summary: IntrinsicElementProps<HTMLElement>; |
| 156 | + sup: IntrinsicElementProps<HTMLElement>; |
| 157 | + table: IntrinsicElementProps<HTMLTableElement>; |
| 158 | + tbody: IntrinsicElementProps<HTMLTableSectionElement>; |
| 159 | + td: IntrinsicElementProps<HTMLTableCellElement>; |
| 160 | + template: IntrinsicElementProps<HTMLTemplateElement>; |
| 161 | + textarea: IntrinsicElementProps<HTMLTextAreaElement>; |
| 162 | + tfoot: IntrinsicElementProps<HTMLTableSectionElement>; |
| 163 | + th: IntrinsicElementProps<HTMLTableCellElement>; |
| 164 | + thead: IntrinsicElementProps<HTMLTableSectionElement>; |
| 165 | + time: IntrinsicElementProps<HTMLTimeElement>; |
| 166 | + title: IntrinsicElementProps<HTMLTitleElement>; |
| 167 | + tr: IntrinsicElementProps<HTMLTableRowElement>; |
| 168 | + track: IntrinsicElementProps<HTMLTrackElement>; |
| 169 | + u: IntrinsicElementProps<HTMLElement>; |
| 170 | + ul: IntrinsicElementProps<HTMLUListElement>; |
| 171 | + var: IntrinsicElementProps<HTMLElement>; |
| 172 | + video: IntrinsicElementProps<HTMLVideoElement>; |
| 173 | + wbr: IntrinsicElementProps<HTMLElement>; |
| 174 | + } |
| 175 | + } |
| 176 | + |
| 177 | + // JSX factory function signature (for TypeScript's classic JSX transform) |
| 178 | + function h( |
| 179 | + tag: string, |
| 180 | + props?: object | null, |
| 181 | + ...children: DOMChild[] |
| 182 | + ): Node; |
| 183 | + function Fragment(props: { children?: DOMChild }): Node; |
| 184 | +} |
| 185 | + |
| 186 | +export {}; |
0 commit comments