@pyreon/document-primitives 0.12.10 → 0.12.11

package/lib/index.d.ts

@@ -38,9 +38,7 @@ declare const DocumentPreview: _pyreon_rocketstyle0.RocketStyleComponent<Partial
   afterContentCss: _pyreon_elements0.ExtendCss;
 }> & _pyreon_core0.PyreonHTMLAttributes<HTMLElement>, {
   size?: string;
-  tag: string;
   showPageBreaks?: boolean;
-  _documentProps: Record<string, unknown>;
 }, {}, {
   backgroundColor: string;
   padding: number;
@@ -81,10 +79,6 @@ declare const DocButton: _pyreon_rocketstyle0.RocketStyleComponent<Partial<{
   tag: _pyreon_ui_core0.HTMLTextTags;
   css: _pyreon_elements0.ExtendCss;
 }> & _pyreon_core0.PyreonHTMLAttributes<HTMLElement>, {
-  tag: string;
-  _documentProps: {
-    href: string;
-  };
   href?: string;
 }, {}, {
   padding: string;
@@ -121,8 +115,6 @@ declare const DocCode: _pyreon_rocketstyle0.RocketStyleComponent<Partial<{
   tag: _pyreon_ui_core0.HTMLTextTags;
   css: _pyreon_elements0.ExtendCss;
 }> & _pyreon_core0.PyreonHTMLAttributes<HTMLElement>, {
-  tag: string;
-  _documentProps: Record<string, unknown>;
   language?: string;
 }, {}, {
   backgroundColor: string;
@@ -180,9 +172,7 @@ declare const DocColumn: _pyreon_rocketstyle0.RocketStyleComponent<Partial<{
   beforeContentCss: _pyreon_elements0.ExtendCss;
   afterContentCss: _pyreon_elements0.ExtendCss;
 }> & _pyreon_core0.PyreonHTMLAttributes<HTMLElement>, {
-  tag: string;
   width?: number | string;
-  _documentProps: Record<string, unknown>;
 }, {}, {}, {
   _documentType: "column";
 }, {}, {
@@ -233,8 +223,6 @@ declare const DocDivider: _pyreon_rocketstyle0.RocketStyleComponent<Partial<{
   beforeContentCss: _pyreon_elements0.ExtendCss;
   afterContentCss: _pyreon_elements0.ExtendCss;
 }> & _pyreon_core0.PyreonHTMLAttributes<HTMLElement>, {
-  tag: string;
-  _documentProps: Record<string, unknown>;
   color?: string;
   thickness?: number;
 }, {}, {
@@ -258,6 +246,52 @@ declare const DocDivider: _pyreon_rocketstyle0.RocketStyleComponent<Partial<{
 }, true, {}>;
 //#endregion
 //#region src/primitives/DocDocument.d.ts
+/**
+ * Root document container with metadata for the export pipeline.
+ *
+ * The `title`, `author`, and `subject` props each accept either a
+ * plain `string` or a `() => string` accessor. Accessors are
+ * resolved by `extractDocumentTree` at export time, so consumers
+ * can pass live signal accessors without capturing values at
+ * component mount.
+ *
+ * **Why accessors are needed**: rocketstyle's `.attrs()` callback
+ * runs ONCE at component mount (see
+ * `packages/ui-system/rocketstyle/src/hoc/rocketstyleAttrsHoc.ts`
+ * line 38: ".attrs() callbacks run once at mount"). If `title` were
+ * `string`-only and a consumer wanted to bind it to a live signal,
+ * they'd have to capture the initial value at template setup time
+ * — meaning the export metadata would be permanently stale relative
+ * to the live UI state.
+ *
+ * Storing the accessor in `_documentProps` and resolving it at
+ * extraction time means every `extractDocumentTree` call (one per
+ * export click) reads the live value. Plain string values still
+ * work as before — `extractDocumentTree` only calls the value if
+ * it's a function.
+ *
+ * @example Plain string
+ * ```tsx
+ * <DocDocument title="My Report" author="Alice">
+ *   ...
+ * </DocDocument>
+ * ```
+ *
+ * @example Reactive accessor (recommended for templates that drive
+ * a live preview AND export the same tree)
+ * ```tsx
+ * function MyTemplate({ resume }: { resume: () => Resume }) {
+ *   return (
+ *     <DocDocument
+ *       title={() => `${resume().name} — Resume`}
+ *       author={() => resume().name}
+ *     >
+ *       ...
+ *     </DocDocument>
+ *   )
+ * }
+ * ```
+ */
 declare const DocDocument: _pyreon_rocketstyle0.RocketStyleComponent<Partial<{
   tag: _pyreon_ui_core0.HTMLTags;
   innerRef: _pyreon_elements0.InnerRef;
@@ -290,11 +324,9 @@ declare const DocDocument: _pyreon_rocketstyle0.RocketStyleComponent<Partial<{
   beforeContentCss: _pyreon_elements0.ExtendCss;
   afterContentCss: _pyreon_elements0.ExtendCss;
 }> & _pyreon_core0.PyreonHTMLAttributes<HTMLElement>, {
-  tag: string;
-  title?: string;
-  _documentProps: Record<string, unknown>;
-  author?: string;
-  subject?: string;
+  title?: string | (() => string);
+  author?: string | (() => string);
+  subject?: string | (() => string);
 }, {}, {}, {
   _documentType: "document";
 }, {}, {
@@ -320,11 +352,7 @@ declare const DocHeading: _pyreon_rocketstyle0.RocketStyleComponent<Partial<{
   tag: _pyreon_ui_core0.HTMLTextTags;
   css: _pyreon_elements0.ExtendCss;
 }> & _pyreon_core0.PyreonHTMLAttributes<HTMLElement>, {
-  tag: string;
   level?: string;
-  _documentProps: {
-    level: number;
-  };
 }, {}, {
   color: string;
   fontWeight: string;
@@ -395,9 +423,7 @@ declare const DocImage: _pyreon_rocketstyle0.RocketStyleComponent<Partial<{
   beforeContentCss: _pyreon_elements0.ExtendCss;
   afterContentCss: _pyreon_elements0.ExtendCss;
 }> & _pyreon_core0.PyreonHTMLAttributes<HTMLElement>, {
-  tag: string;
   width?: number | string;
-  _documentProps: Record<string, unknown>;
   caption?: string;
   height?: number | string;
   src?: string;
@@ -427,10 +453,6 @@ declare const DocLink: _pyreon_rocketstyle0.RocketStyleComponent<Partial<{
   tag: _pyreon_ui_core0.HTMLTextTags;
   css: _pyreon_elements0.ExtendCss;
 }> & _pyreon_core0.PyreonHTMLAttributes<HTMLElement>, {
-  tag: string;
-  _documentProps: {
-    href: string;
-  };
   href?: string;
 }, {}, {
   color: string;
@@ -485,8 +507,6 @@ declare const DocList: _pyreon_rocketstyle0.RocketStyleComponent<Partial<{
   beforeContentCss: _pyreon_elements0.ExtendCss;
   afterContentCss: _pyreon_elements0.ExtendCss;
 }> & _pyreon_core0.PyreonHTMLAttributes<HTMLElement>, {
-  tag: string;
-  _documentProps: Record<string, unknown>;
   ordered?: boolean;
 }, {}, {
   marginBottom: number;
@@ -515,10 +535,7 @@ declare const DocListItem: _pyreon_rocketstyle0.RocketStyleComponent<Partial<{
   paragraph: boolean;
   tag: _pyreon_ui_core0.HTMLTextTags;
   css: _pyreon_elements0.ExtendCss;
-}> & _pyreon_core0.PyreonHTMLAttributes<HTMLElement>, {
-  tag: string;
-  _documentProps: Record<string, unknown>;
-}, {}, {
+}> & _pyreon_core0.PyreonHTMLAttributes<HTMLElement>, {}, {}, {
   fontSize: number;
   lineHeight: number;
 }, {
@@ -572,9 +589,7 @@ declare const DocPage: _pyreon_rocketstyle0.RocketStyleComponent<Partial<{
   afterContentCss: _pyreon_elements0.ExtendCss;
 }> & _pyreon_core0.PyreonHTMLAttributes<HTMLElement>, {
   size?: string;
-  tag: string;
   orientation?: string;
-  _documentProps: Record<string, unknown>;
 }, {}, {
   backgroundColor: string;
   padding: string;
@@ -627,10 +642,7 @@ declare const DocPageBreak: _pyreon_rocketstyle0.RocketStyleComponent<Partial<{
   contentCss: _pyreon_elements0.ExtendCss;
   beforeContentCss: _pyreon_elements0.ExtendCss;
   afterContentCss: _pyreon_elements0.ExtendCss;
-}> & _pyreon_core0.PyreonHTMLAttributes<HTMLElement>, {
-  tag: string;
-  _documentProps: Record<string, unknown>;
-}, {}, {}, {
+}> & _pyreon_core0.PyreonHTMLAttributes<HTMLElement>, {}, {}, {}, {
   _documentType: "page-break";
 }, {}, {
   readonly states: "state";
@@ -680,8 +692,6 @@ declare const DocQuote: _pyreon_rocketstyle0.RocketStyleComponent<Partial<{
   beforeContentCss: _pyreon_elements0.ExtendCss;
   afterContentCss: _pyreon_elements0.ExtendCss;
 }> & _pyreon_core0.PyreonHTMLAttributes<HTMLElement>, {
-  tag: string;
-  _documentProps: Record<string, unknown>;
   borderColor?: string;
 }, {}, {
   padding: string;
@@ -706,6 +716,12 @@ declare const DocQuote: _pyreon_rocketstyle0.RocketStyleComponent<Partial<{
 }, true, {}>;
 //#endregion
 //#region src/primitives/DocRow.d.ts
+/**
+ * Horizontal row of inline children. Per project conventions, layout
+ * props (`direction`, `gap`) live in `.attrs()`, not `.theme()`. The
+ * Element base accepts `direction: 'inline' | 'rows' | 'reverseInline'
+ * | 'reverseRows'` — `'row'` is not a valid value.
+ */
 declare const DocRow: _pyreon_rocketstyle0.RocketStyleComponent<Partial<{
   tag: _pyreon_ui_core0.HTMLTags;
   innerRef: _pyreon_elements0.InnerRef;
@@ -737,12 +753,7 @@ declare const DocRow: _pyreon_rocketstyle0.RocketStyleComponent<Partial<{
   contentCss: _pyreon_elements0.ExtendCss;
   beforeContentCss: _pyreon_elements0.ExtendCss;
   afterContentCss: _pyreon_elements0.ExtendCss;
-}> & _pyreon_core0.PyreonHTMLAttributes<HTMLElement>, {
-  tag: string;
-  _documentProps: Record<string, unknown>;
-}, {}, {
-  direction: string;
-}, {
+}> & _pyreon_core0.PyreonHTMLAttributes<HTMLElement>, {}, {}, {}, {
   _documentType: "row";
 }, {}, {
   readonly states: "state";
@@ -792,11 +803,7 @@ declare const DocSection: _pyreon_rocketstyle0.RocketStyleComponent<Partial<{
   beforeContentCss: _pyreon_elements0.ExtendCss;
   afterContentCss: _pyreon_elements0.ExtendCss;
 }> & _pyreon_core0.PyreonHTMLAttributes<HTMLElement>, {
-  tag: string;
   direction?: string;
-  _documentProps: {
-    direction: string;
-  };
 }, {}, {
   padding: number;
 }, {
@@ -845,10 +852,6 @@ declare const DocSpacer: _pyreon_rocketstyle0.RocketStyleComponent<Partial<{
   beforeContentCss: _pyreon_elements0.ExtendCss;
   afterContentCss: _pyreon_elements0.ExtendCss;
 }> & _pyreon_core0.PyreonHTMLAttributes<HTMLElement>, {
-  tag: string;
-  _documentProps: {
-    height: number;
-  };
   height?: number;
 }, {}, {}, {
   _documentType: "spacer";
@@ -868,6 +871,24 @@ declare const DocSpacer: _pyreon_rocketstyle0.RocketStyleComponent<Partial<{
 }, true, {}>;
 //#endregion
 //#region src/primitives/DocTable.d.ts
+/**
+ * Tabular data primitive.
+ *
+ * The `columns`, `rows`, `headerStyle`, `striped`, `bordered`, and
+ * `caption` props are document-export metadata — they belong in
+ * `_documentProps` only and must NOT be forwarded to the rendered
+ * `<table>` element. The `filter` option on `.attrs()` strips them
+ * from the props that flow into the DOM.
+ *
+ * Why this matters: HTMLTableElement's `rows` property is a
+ * read-only `HTMLCollection` of `<tr>` elements. If `rows` were
+ * forwarded as a DOM attr, the runtime would call
+ * `el.rows = [...]` and crash with
+ * `TypeError: Cannot set property rows of [object Object] which has
+ * only a getter`. Same family for `columns` (`HTMLTableColElement`'s
+ * column collection on parent table). Filtering them at the
+ * rocketstyle layer keeps the DOM render path clean.
+ */
 declare const DocTable: _pyreon_rocketstyle0.RocketStyleComponent<Partial<{
   tag: _pyreon_ui_core0.HTMLTags;
   innerRef: _pyreon_elements0.InnerRef;
@@ -900,8 +921,6 @@ declare const DocTable: _pyreon_rocketstyle0.RocketStyleComponent<Partial<{
   beforeContentCss: _pyreon_elements0.ExtendCss;
   afterContentCss: _pyreon_elements0.ExtendCss;
 }> & _pyreon_core0.PyreonHTMLAttributes<HTMLElement>, {
-  tag: string;
-  _documentProps: Record<string, unknown>;
   caption?: string;
   rows?: unknown[];
   columns?: unknown[];
@@ -924,10 +943,7 @@ declare const DocText: _pyreon_rocketstyle0.RocketStyleComponent<Partial<{
   paragraph: boolean;
   tag: _pyreon_ui_core0.HTMLTextTags;
   css: _pyreon_elements0.ExtendCss;
-}> & _pyreon_core0.PyreonHTMLAttributes<HTMLElement>, {
-  tag: string;
-  _documentProps: Record<string, unknown>;
-}, {}, {
+}> & _pyreon_core0.PyreonHTMLAttributes<HTMLElement>, {}, {}, {
   color: string;
   lineHeight: number;
   marginBottom: number;
@@ -1012,6 +1028,39 @@ interface DocumentExport {
   /** Extract the DocNode tree from the template. */
   getDocNode: () => DocNode$1;
 }
+/**
+ * One-step helper: extract a DocNode tree from a template function.
+ *
+ * Equivalent to `createDocumentExport(templateFn).getDocNode()` but
+ * without the wrapper-object indirection. Use this when you just
+ * need the tree to feed into `@pyreon/document`'s `render()` or
+ * `download()` — which is the only thing the wrapper object was
+ * ever used for in practice.
+ *
+ * ```ts
+ * import { extractDocNode } from '@pyreon/document-primitives'
+ * import { download } from '@pyreon/document'
+ *
+ * function ResumeTemplate({ resume }: { resume: () => Resume }) {
+ *   return (
+ *     <DocDocument title={() => `${resume().name} — Resume`}>
+ *       <DocPage>...</DocPage>
+ *     </DocDocument>
+ *   )
+ * }
+ *
+ * // Export click handler:
+ * const tree = extractDocNode(() => <ResumeTemplate resume={store.resume} />)
+ * await download(tree, 'resume.pdf')
+ * ```
+ *
+ * The two-step `createDocumentExport` form is still exported for
+ * backward compatibility and for callers that want to pass the
+ * helper object around (e.g. to wrapper components that take a
+ * `DocumentExport` instance). New code should prefer this one-step
+ * form unless you specifically need the helper object.
+ */
+declare function extractDocNode(templateFn: () => unknown, options?: DocumentExportOptions): DocNode$1;
 /**
  * Create a document export helper from a template function.
  *
@@ -1030,10 +1079,12 @@ interface DocumentExport {
  * // Pass to @pyreon/document's render() for any format
  * ```
  *
- * When @pyreon/document is published, this will also expose
- * convenience methods like toPdf(), toDocx(), download(), etc.
+ * **Most consumers should use `extractDocNode(templateFn)` instead**
+ * — it's the same operation in one call without the wrapper
+ * object. `createDocumentExport` is kept for callers that want to
+ * pass the helper object around.
  */
 declare function createDocumentExport(templateFn: () => unknown, options?: DocumentExportOptions): DocumentExport;
 //#endregion
-export { DocButton, type DocChild, DocCode, DocColumn, DocDivider, DocDocument, DocHeading, DocImage, DocLink, DocList, DocListItem, type DocNode, DocPage, DocPageBreak, DocQuote, DocRow, DocSection, DocSpacer, DocTable, DocText, type DocumentExport, type DocumentExportOptions, DocumentPreview, type DocumentTheme, type ExtractOptions, type NodeType, type ResolvedStyles, createDocumentExport, documentTheme, extractDocumentTree, resolveStyles };
+export { DocButton, type DocChild, DocCode, DocColumn, DocDivider, DocDocument, DocHeading, DocImage, DocLink, DocList, DocListItem, type DocNode, DocPage, DocPageBreak, DocQuote, DocRow, DocSection, DocSpacer, DocTable, DocText, type DocumentExport, type DocumentExportOptions, DocumentPreview, type DocumentTheme, type ExtractOptions, type NodeType, type ResolvedStyles, createDocumentExport, documentTheme, extractDocNode, extractDocumentTree, resolveStyles };
 //# sourceMappingURL=index2.d.ts.map

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index2.d.ts","names":[],"sources":["../../src/DocumentPreview.ts","../../src/primitives/DocButton.ts","../../src/primitives/DocCode.ts","../../src/primitives/DocColumn.ts","../../src/primitives/DocDivider.ts","../../src/primitives/DocDocument.ts","../../src/primitives/DocHeading.ts","../../src/primitives/DocImage.ts","../../src/primitives/DocLink.ts","../../src/primitives/DocList.ts","../../src/primitives/DocListItem.ts","../../src/primitives/DocPage.ts","../../src/primitives/DocPageBreak.ts","../../src/primitives/DocQuote.ts","../../src/primitives/DocRow.ts","../../src/primitives/DocSection.ts","../../src/primitives/DocSpacer.ts","../../src/primitives/DocTable.ts","../../src/primitives/DocText.ts","../../src/theme.ts","../../src/useDocumentExport.ts"],"mappings":";;;;;;;cAGM,eAAA,uBAAe,oBAAA,CAAA,OAAA;OA4ChB,gBAAA,CAAA,QAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAPe,MAAA;AAAA;;;;;;;SAAM,oBAAA,CAAA,cAAA;EAAA;;;;;;;;;;;;;;;;;;;;;;;;;cCrCpB,SAAA,uBAAS,oBAAA,CAAA,OAAA;SA+BV,aAAA,CAAA,UAAA;;;;;;;;IAHoD,IAAA;EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cC5BnD,OAAA,EAS2D,oBAAA,CATpD,oBAAA,CAAA,OAAA;SAYR,aAAA,CAAA,UAAA;;;;;;;kBAHsD,MAAA;;;;;;;;;;;;;;;;;;;;;;;;;;cCTrD,SAAA,EAEiE,oBAAA,CAFxD,oBAAA,CAAA,OAAA;OAOZ,gBAAA,CAAA,QAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAL8D,MAAA;AAAA;;;;;;;;;;;;;;;;;;cCF3D,UAAA,EAUoB,oBAAA,CAVV,oBAAA,CAAA,OAAA;OAiBX,gBAAA,CAAA,QAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAPe,MAAA;;;;;;;;;;;;;;;;;;;;;;;;cCVd,WAAA,EAOoB,oBAAA,CAPT,oBAAA,CAAA,OAAA;OAeZ,gBAAA,CAAA,QAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBARe,MAAA;;;;;;;;;;;;;;;;;;;;;cCPd,UAAA,uBAAU,oBAAA,CAAA,OAAA;SA2BZ,aAAA,CAAA,UAAA;;;;;;;;;IAPsD,KAAA;EAAA;AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cCpBpD,QAAA,EASoB,oBAAA,CATZ,oBAAA,CAAA,OAAA;OAmBT,gBAAA,CAAA,QAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAVe,MAAA;;;;;;;;;;;;;;;;;;;;;;;cCTd,OAAA,uBAAO,oBAAA,CAAA,OAAA;SASR,aAAA,CAAA,UAAA;;;;;;;;IAHoD,IAAA;EAAA;;;;;;;;;;;;;;;;;;;;;;;cCNnD,OAAA,EAM2D,oBAAA,CANpD,oBAAA,CAAA,OAAA;OASR,gBAAA,CAAA,QAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAHsD,MAAA;;;;;;;;;;;;;;;;;;;;;;;cCNrD,WAAA,EAMwC,oBAAA,CAN7B,oBAAA,CAAA,OAAA;SASZ,aAAA,CAAA,UAAA;;;;;;;kBAHmC,MAAA;AAAA;;;;;;;;;;;;;;;;;;;;;cCNlC,OAAA,EAUoB,oBAAA,CAVb,oBAAA,CAAA,OAAA;OAiBR,gBAAA,CAAA,QAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAPe,MAAA;AAAA;;;;;;;;;;;;;;;;;;;;;cCVd,YAAA,EAEwC,oBAAA,CAF5B,oBAAA,CAAA,OAAA;OAKb,gBAAA,CAAA,QAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAHmC,MAAA;AAAA;;;;;;;;;;;;;;;;;;cCFlC,QAAA,EAQ8D,oBAAA,CARtD,oBAAA,CAAA,OAAA;OAaX,gBAAA,CAAA,QAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAL2D,MAAA;;;;;;;;;;;;;;;;;;;;;;;;;cCRxD,MAAA,EAKwC,oBAAA,CALlC,oBAAA,CAAA,OAAA;OAQP,gBAAA,CAAA,QAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAHmC,MAAA;AAAA;;;;;;;;;;;;;;;;;;;;cCLlC,UAAA,uBAAU,oBAAA,CAAA,OAAA;OAiBX,gBAAA,CAAA,QAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAHyD,SAAA;EAAA;AAAA;;;;;;;;;;;;;;;;cCdxD,SAAA,uBAAS,oBAAA,CAAA,OAAA;OAKV,gBAAA,CAAA,QAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAHsD,MAAA;EAAA;;;;;;;;;;;;;;;;;;;;cCFrD,QAAA,EAckB,oBAAA,CAdV,oBAAA,CAAA,OAAA;OA8BT,gBAAA,CAAA,QAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAXe,MAAA;;;;gBALF,MAAA;;;;;;;;;;;;;cCdZ,OAAA,uBAAO,oBAAA,CAAA,OAAA;SA6BR,aAAA,CAAA,UAAA;;;;;;;kBAHmC,MAAA;AAAA;;;;;;;;;;;;;;;;;;;GAAM,oBAAA,CAAA,cAAA;EAAA;;;;;;;;;;;;;;;;;cC7BjC,aAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAoCD,aAAA,UAAuB,aAAA;;;UCjClB,qBAAA,SAA8B,gBAAA;;EAE7C,KAAA,GAAQ,MAAA;;EAER,IAAA;AAAA;AAAA,UAGe,cAAA;EpBqCZ;EoBnCH,UAAA,QAAkB,SAAA;AAAA;;;;;;;;;;;;;;;;;;;;;;iBAwBJ,oBAAA,CACd,UAAA,iBACA,OAAA,GAAS,qBAAA,GACR,cAAA"}
+{"version":3,"file":"index2.d.ts","names":[],"sources":["../../src/DocumentPreview.ts","../../src/primitives/DocButton.ts","../../src/primitives/DocCode.ts","../../src/primitives/DocColumn.ts","../../src/primitives/DocDivider.ts","../../src/primitives/DocDocument.ts","../../src/primitives/DocHeading.ts","../../src/primitives/DocImage.ts","../../src/primitives/DocLink.ts","../../src/primitives/DocList.ts","../../src/primitives/DocListItem.ts","../../src/primitives/DocPage.ts","../../src/primitives/DocPageBreak.ts","../../src/primitives/DocQuote.ts","../../src/primitives/DocRow.ts","../../src/primitives/DocSection.ts","../../src/primitives/DocSpacer.ts","../../src/primitives/DocTable.ts","../../src/primitives/DocText.ts","../../src/theme.ts","../../src/useDocumentExport.ts"],"mappings":";;;;;;;cAGM,eAAA,uBAAe,oBAAA,CAAA,OAAA;OA0ChB,gBAAA,CAAA,QAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cC1CC,SAAA,uBAAS,oBAAA,CAAA,OAAA;SA+BV,aAAA,CAAA,UAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cC/BC,OAAA,uBAAO,oBAAA,CAAA,OAAA;SAYR,aAAA,CAAA,UAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cCZC,SAAA,uBAAS,oBAAA,CAAA,OAAA;OAKV,gBAAA,CAAA,QAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cCLC,UAAA,uBAAU,oBAAA,CAAA,OAAA;OAeX,gBAAA,CAAA,QAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cC+BC,WAAA,uBAAW,oBAAA,CAAA,OAAA;OAiBZ,gBAAA,CAAA,QAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cC/DC,UAAA,uBAAU,oBAAA,CAAA,OAAA;SA2BZ,aAAA,CAAA,UAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cC3BE,QAAA,uBAAQ,oBAAA,CAAA,OAAA;OAiBT,gBAAA,CAAA,QAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cCjBC,OAAA,uBAAO,oBAAA,CAAA,OAAA;SASR,aAAA,CAAA,UAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;cCTC,OAAA,uBAAO,oBAAA,CAAA,OAAA;OASR,gBAAA,CAAA,QAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cCTC,WAAA,uBAAW,oBAAA,CAAA,OAAA;SASZ,aAAA,CAAA,UAAA;;;;;;;;;;;;;;;;;;;;;;;;;;cCTC,OAAA,uBAAO,oBAAA,CAAA,OAAA;OAeR,gBAAA,CAAA,QAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cCfC,YAAA,uBAAY,oBAAA,CAAA,OAAA;OAKb,gBAAA,CAAA,QAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cCLC,QAAA,uBAAQ,oBAAA,CAAA,OAAA;OAWT,gBAAA,CAAA,QAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cCLC,MAAA,uBAAM,oBAAA,CAAA,OAAA;OAOP,gBAAA,CAAA,QAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cCbC,UAAA,uBAAU,oBAAA,CAAA,OAAA;OAiBX,gBAAA,CAAA,QAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cCjBC,SAAA,uBAAS,oBAAA,CAAA,OAAA;OAKV,gBAAA,CAAA,QAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cCaC,QAAA,EAckB,oBAAA,CAdV,oBAAA,CAAA,OAAA;OAiCX,gBAAA,CAAA,QAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;gBAnBe,MAAA;;;;;;;;;;;;;cChCZ,OAAA,uBAAO,oBAAA,CAAA,OAAA;SAyBR,aAAA,CAAA,UAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cC5BQ,aAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAoCD,aAAA,UAAuB,aAAA;;;UCjClB,qBAAA,SAA8B,gBAAA;;EAE7C,KAAA,GAAQ,MAAA;;EAER,IAAA;AAAA;AAAA,UAGe,cAAA;EpBmCZ;EoBjCH,UAAA,QAAkB,SAAA;AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAmCJ,cAAA,CACd,UAAA,iBACA,OAAA,GAAS,qBAAA,GACR,SAAA;;;;;;;;;;;;;;;;;;;;;;;;iBA2Ba,oBAAA,CACd,UAAA,iBACA,OAAA,GAAS,qBAAA,GACR,cAAA"}

package/lib/index.js

@@ -129,15 +129,61 @@ const DocDivider = rocketstyle()({
 
 //#endregion
 //#region src/primitives/DocDocument.ts
+/**
+* Root document container with metadata for the export pipeline.
+*
+* The `title`, `author`, and `subject` props each accept either a
+* plain `string` or a `() => string` accessor. Accessors are
+* resolved by `extractDocumentTree` at export time, so consumers
+* can pass live signal accessors without capturing values at
+* component mount.
+*
+* **Why accessors are needed**: rocketstyle's `.attrs()` callback
+* runs ONCE at component mount (see
+* `packages/ui-system/rocketstyle/src/hoc/rocketstyleAttrsHoc.ts`
+* line 38: ".attrs() callbacks run once at mount"). If `title` were
+* `string`-only and a consumer wanted to bind it to a live signal,
+* they'd have to capture the initial value at template setup time
+* — meaning the export metadata would be permanently stale relative
+* to the live UI state.
+*
+* Storing the accessor in `_documentProps` and resolving it at
+* extraction time means every `extractDocumentTree` call (one per
+* export click) reads the live value. Plain string values still
+* work as before — `extractDocumentTree` only calls the value if
+* it's a function.
+*
+* @example Plain string
+* ```tsx
+* <DocDocument title="My Report" author="Alice">
+*   ...
+* </DocDocument>
+* ```
+*
+* @example Reactive accessor (recommended for templates that drive
+* a live preview AND export the same tree)
+* ```tsx
+* function MyTemplate({ resume }: { resume: () => Resume }) {
+*   return (
+*     <DocDocument
+*       title={() => `${resume().name} — Resume`}
+*       author={() => resume().name}
+*     >
+*       ...
+*     </DocDocument>
+*   )
+* }
+* ```
+*/
 const DocDocument = rocketstyle()({
 	name: "DocDocument",
 	component: Element
 }).statics({ _documentType: "document" }).attrs((props) => ({
 	tag: "div",
 	_documentProps: {
-		...props.title ? { title: props.title } : {},
-		...props.author ? { author: props.author } : {},
-		...props.subject ? { subject: props.subject } : {}
+		...props.title != null ? { title: props.title } : {},
+		...props.author != null ? { author: props.author } : {},
+		...props.subject != null ? { subject: props.subject } : {}
 	}
 }));
 
@@ -236,7 +282,7 @@ const DocListItem = rocketstyle()({
 }).theme({
 	fontSize: 14,
 	lineHeight: 1.5
-}).statics({ _documentType: "list-item" }).attrs((_props) => ({
+}).statics({ _documentType: "list-item" }).attrs(() => ({
 	tag: "li",
 	_documentProps: {}
 }));
@@ -262,7 +308,7 @@ const DocPage = rocketstyle()({
 const DocPageBreak = rocketstyle()({
 	name: "DocPageBreak",
 	component: Element
-}).statics({ _documentType: "page-break" }).attrs((_props) => ({
+}).statics({ _documentType: "page-break" }).attrs(() => ({
 	tag: "div",
 	_documentProps: {}
 }));
@@ -284,11 +330,19 @@ const DocQuote = rocketstyle()({
 
 //#endregion
 //#region src/primitives/DocRow.ts
+/**
+* Horizontal row of inline children. Per project conventions, layout
+* props (`direction`, `gap`) live in `.attrs()`, not `.theme()`. The
+* Element base accepts `direction: 'inline' | 'rows' | 'reverseInline'
+* | 'reverseRows'` — `'row'` is not a valid value.
+*/
 const DocRow = rocketstyle()({
 	name: "DocRow",
 	component: Element
-}).theme({ direction: "row" }).statics({ _documentType: "row" }).attrs((_props) => ({
+}).statics({ _documentType: "row" }).attrs(() => ({
 	tag: "div",
+	direction: "inline",
+	gap: 8,
 	_documentProps: {}
 }));
 
@@ -320,6 +374,24 @@ const DocSpacer = rocketstyle()({
 
 //#endregion
 //#region src/primitives/DocTable.ts
+/**
+* Tabular data primitive.
+*
+* The `columns`, `rows`, `headerStyle`, `striped`, `bordered`, and
+* `caption` props are document-export metadata — they belong in
+* `_documentProps` only and must NOT be forwarded to the rendered
+* `<table>` element. The `filter` option on `.attrs()` strips them
+* from the props that flow into the DOM.
+*
+* Why this matters: HTMLTableElement's `rows` property is a
+* read-only `HTMLCollection` of `<tr>` elements. If `rows` were
+* forwarded as a DOM attr, the runtime would call
+* `el.rows = [...]` and crash with
+* `TypeError: Cannot set property rows of [object Object] which has
+* only a getter`. Same family for `columns` (`HTMLTableColElement`'s
+* column collection on parent table). Filtering them at the
+* rocketstyle layer keeps the DOM render path clean.
+*/
 const DocTable = rocketstyle({
 	dimensions: { variants: "variant" },
 	useBooleans: true
@@ -339,7 +411,14 @@ const DocTable = rocketstyle({
 		...props.bordered ? { bordered: props.bordered } : {},
 		...props.caption ? { caption: props.caption } : {}
 	}
-}));
+}), { filter: [
+	"columns",
+	"rows",
+	"headerStyle",
+	"striped",
+	"bordered",
+	"caption"
+] });
 
 //#endregion
 //#region src/primitives/DocText.ts
@@ -369,7 +448,7 @@ const DocText = rocketstyle({
 }).weights({
 	normal: { fontWeight: "normal" },
 	bold: { fontWeight: "bold" }
-}).statics({ _documentType: "text" }).attrs((_props) => ({
+}).statics({ _documentType: "text" }).attrs(() => ({
 	tag: "p",
 	_documentProps: {}
 }));
@@ -415,6 +494,41 @@ const documentTheme = {
 //#endregion
 //#region src/useDocumentExport.ts
 /**
+* One-step helper: extract a DocNode tree from a template function.
+*
+* Equivalent to `createDocumentExport(templateFn).getDocNode()` but
+* without the wrapper-object indirection. Use this when you just
+* need the tree to feed into `@pyreon/document`'s `render()` or
+* `download()` — which is the only thing the wrapper object was
+* ever used for in practice.
+*
+* ```ts
+* import { extractDocNode } from '@pyreon/document-primitives'
+* import { download } from '@pyreon/document'
+*
+* function ResumeTemplate({ resume }: { resume: () => Resume }) {
+*   return (
+*     <DocDocument title={() => `${resume().name} — Resume`}>
+*       <DocPage>...</DocPage>
+*     </DocDocument>
+*   )
+* }
+*
+* // Export click handler:
+* const tree = extractDocNode(() => <ResumeTemplate resume={store.resume} />)
+* await download(tree, 'resume.pdf')
+* ```
+*
+* The two-step `createDocumentExport` form is still exported for
+* backward compatibility and for callers that want to pass the
+* helper object around (e.g. to wrapper components that take a
+* `DocumentExport` instance). New code should prefer this one-step
+* form unless you specifically need the helper object.
+*/
+function extractDocNode(templateFn, options = {}) {
+	return extractDocumentTree$1(templateFn(), options);
+}
+/**
 * Create a document export helper from a template function.
 *
 * The template function should return a VNode tree built with
@@ -432,16 +546,16 @@ const documentTheme = {
 * // Pass to @pyreon/document's render() for any format
 * ```
 *
-* When @pyreon/document is published, this will also expose
-* convenience methods like toPdf(), toDocx(), download(), etc.
+* **Most consumers should use `extractDocNode(templateFn)` instead**
+* — it's the same operation in one call without the wrapper
+* object. `createDocumentExport` is kept for callers that want to
+* pass the helper object around.
 */
 function createDocumentExport(templateFn, options = {}) {
-	const getDocNode = () => {
-		return extractDocumentTree$1(templateFn(), options);
-	};
+	const getDocNode = () => extractDocNode(templateFn, options);
 	return { getDocNode };
 }
 
 //#endregion
-export { DocButton, DocCode, DocColumn, DocDivider, DocDocument, DocHeading, DocImage, DocLink, DocList, DocListItem, DocPage, DocPageBreak, DocQuote, DocRow, DocSection, DocSpacer, DocTable, DocText, DocumentPreview, createDocumentExport, documentTheme, extractDocumentTree, resolveStyles };
+export { DocButton, DocCode, DocColumn, DocDivider, DocDocument, DocHeading, DocImage, DocLink, DocList, DocListItem, DocPage, DocPageBreak, DocQuote, DocRow, DocSection, DocSpacer, DocTable, DocText, DocumentPreview, createDocumentExport, documentTheme, extractDocNode, extractDocumentTree, resolveStyles };
 //# sourceMappingURL=index.js.map