structured-render 0.0.0 → 0.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (60) hide show
  1. package/LICENSE-CC0 +121 -0
  2. package/LICENSE-MIT +21 -0
  3. package/README.md +13 -0
  4. package/dist/augments/shadow-styles.d.ts +7 -0
  5. package/dist/augments/shadow-styles.js +17 -0
  6. package/dist/elements/vir-markdown.element.d.ts +16 -0
  7. package/dist/elements/vir-markdown.element.js +73 -0
  8. package/dist/elements/vir-source.element.d.ts +24 -0
  9. package/dist/elements/vir-source.element.js +158 -0
  10. package/dist/elements/vir-structured-render.element.d.ts +19 -0
  11. package/dist/elements/vir-structured-render.element.js +346 -0
  12. package/dist/index.d.ts +26 -0
  13. package/dist/index.js +26 -0
  14. package/dist/render/browser-rendering.d.ts +90 -0
  15. package/dist/render/browser-rendering.js +233 -0
  16. package/dist/render/html-to-pdf.d.ts +50 -0
  17. package/dist/render/html-to-pdf.js +7 -0
  18. package/dist/render/render-html.d.ts +38 -0
  19. package/dist/render/render-html.js +504 -0
  20. package/dist/render/render-image.d.ts +24 -0
  21. package/dist/render/render-image.js +35 -0
  22. package/dist/render/render-markdown-styles.d.ts +62 -0
  23. package/dist/render/render-markdown-styles.js +242 -0
  24. package/dist/render/render-markdown.d.ts +8 -0
  25. package/dist/render/render-markdown.js +169 -0
  26. package/dist/render/render-pdf.d.ts +35 -0
  27. package/dist/render/render-pdf.js +65 -0
  28. package/dist/render/render-types.d.ts +134 -0
  29. package/dist/render/render-types.js +41 -0
  30. package/dist/structured-render-data/create-section.d.ts +23 -0
  31. package/dist/structured-render-data/create-section.js +16 -0
  32. package/dist/structured-render-data/sections/code-block.section.d.ts +30 -0
  33. package/dist/structured-render-data/sections/code-block.section.js +11 -0
  34. package/dist/structured-render-data/sections/empty.section.d.ts +14 -0
  35. package/dist/structured-render-data/sections/empty.section.js +9 -0
  36. package/dist/structured-render-data/sections/icon.section.d.ts +25 -0
  37. package/dist/structured-render-data/sections/icon.section.js +40 -0
  38. package/dist/structured-render-data/sections/inline-code.section.d.ts +29 -0
  39. package/dist/structured-render-data/sections/inline-code.section.js +9 -0
  40. package/dist/structured-render-data/sections/list.section.d.ts +169 -0
  41. package/dist/structured-render-data/sections/list.section.js +29 -0
  42. package/dist/structured-render-data/sections/markdown.section.d.ts +29 -0
  43. package/dist/structured-render-data/sections/markdown.section.js +9 -0
  44. package/dist/structured-render-data/sections/processing.section.d.ts +14 -0
  45. package/dist/structured-render-data/sections/processing.section.js +9 -0
  46. package/dist/structured-render-data/sections/source.section.d.ts +59 -0
  47. package/dist/structured-render-data/sections/source.section.js +47 -0
  48. package/dist/structured-render-data/sections/table.section.d.ts +939 -0
  49. package/dist/structured-render-data/sections/table.section.js +99 -0
  50. package/dist/structured-render-data/sections/tag.section.d.ts +39 -0
  51. package/dist/structured-render-data/sections/tag.section.js +20 -0
  52. package/dist/structured-render-data/sections/text.section.d.ts +48 -0
  53. package/dist/structured-render-data/sections/text.section.js +25 -0
  54. package/dist/structured-render-data/structured-render-card.d.ts +918 -0
  55. package/dist/structured-render-data/structured-render-card.js +11 -0
  56. package/dist/structured-render-data/structured-render-data.d.ts +919 -0
  57. package/dist/structured-render-data/structured-render-data.js +8 -0
  58. package/dist/structured-render-data/structured-render-section.d.ts +1857 -0
  59. package/dist/structured-render-data/structured-render-section.js +115 -0
  60. package/package.json +75 -11
@@ -0,0 +1,23 @@
1
+ import { type AnyObject } from '@augment-vir/common';
2
+ /**
3
+ * Used to create a new structured render section with common properties. Not _all_ sections use
4
+ * this, but most do.
5
+ *
6
+ * @category Internal
7
+ */
8
+ export declare function createStructuredRenderSection<const Type extends string, ExtraProperties extends AnyObject>(structuredRenderType: Type, extraProperties: ExtraProperties): import("object-shape-tester").Shape<{
9
+ type: import("object-shape-tester").Shape<import("@sinclair/typebox").TUnsafe<Type>>;
10
+ sectionTitle: import("object-shape-tester").Shape<import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TString | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>>;
11
+ sources: import("object-shape-tester").Shape<import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TArray<import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TObject<{
12
+ type: import("@sinclair/typebox").TUnsafe<"source">;
13
+ pageNumbers: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TArray<import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNumber | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>>)[]>>;
14
+ fileName: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TString | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>;
15
+ fileBoundingBoxes: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TArray<import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TObject<{
16
+ x1: import("@sinclair/typebox").TNumber;
17
+ y1: import("@sinclair/typebox").TNumber;
18
+ x2: import("@sinclair/typebox").TNumber;
19
+ y2: import("@sinclair/typebox").TNumber;
20
+ }>)[]>>>)[]>>;
21
+ quote: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TString | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>;
22
+ }>)[]>>>)[]>>>;
23
+ } & ExtraProperties>;
@@ -0,0 +1,16 @@
1
+ import { defineShape, exactShape, nullableShape } from 'object-shape-tester';
2
+ import { structuredRenderSourceShape } from './sections/source.section.js';
3
+ /**
4
+ * Used to create a new structured render section with common properties. Not _all_ sections use
5
+ * this, but most do.
6
+ *
7
+ * @category Internal
8
+ */
9
+ export function createStructuredRenderSection(structuredRenderType, extraProperties) {
10
+ return defineShape({
11
+ type: exactShape(structuredRenderType),
12
+ sectionTitle: nullableShape(''),
13
+ sources: nullableShape([nullableShape(structuredRenderSourceShape)]),
14
+ ...extraProperties,
15
+ });
16
+ }
@@ -0,0 +1,30 @@
1
+ /**
2
+ * Shape definition for {@link StructuredRenderCodeBlock}.
3
+ *
4
+ * @category Internal
5
+ */
6
+ export declare const structuredRenderCodeBlockShape: import("object-shape-tester").Shape<{
7
+ type: import("object-shape-tester").Shape<import("@sinclair/typebox").TUnsafe<"codeBlock">>;
8
+ sectionTitle: import("object-shape-tester").Shape<import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TString | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>>;
9
+ sources: import("object-shape-tester").Shape<import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TArray<import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TObject<{
10
+ type: import("@sinclair/typebox").TUnsafe<"source">;
11
+ pageNumbers: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TArray<import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNumber | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>>)[]>>;
12
+ fileName: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TString | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>;
13
+ fileBoundingBoxes: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TArray<import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TObject<{
14
+ x1: import("@sinclair/typebox").TNumber;
15
+ y1: import("@sinclair/typebox").TNumber;
16
+ x2: import("@sinclair/typebox").TNumber;
17
+ y2: import("@sinclair/typebox").TNumber;
18
+ }>)[]>>>)[]>>;
19
+ quote: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TString | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>;
20
+ }>)[]>>>)[]>>>;
21
+ } & {
22
+ syntax: import("object-shape-tester").Shape<import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TString | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>>;
23
+ code: string;
24
+ }>;
25
+ /**
26
+ * A section that renders a block of code.
27
+ *
28
+ * @category Section
29
+ */
30
+ export type StructuredRenderCodeBlock = typeof structuredRenderCodeBlockShape.runtimeType;
@@ -0,0 +1,11 @@
1
+ import { nullableShape } from 'object-shape-tester';
2
+ import { createStructuredRenderSection } from '../create-section.js';
3
+ /**
4
+ * Shape definition for {@link StructuredRenderCodeBlock}.
5
+ *
6
+ * @category Internal
7
+ */
8
+ export const structuredRenderCodeBlockShape = createStructuredRenderSection('codeBlock', {
9
+ syntax: nullableShape(''),
10
+ code: '',
11
+ });
@@ -0,0 +1,14 @@
1
+ /**
2
+ * Shape definition for {@link StructuredRenderEmpty}.
3
+ *
4
+ * @category Internal
5
+ */
6
+ export declare const structuredRenderEmptyShape: import("object-shape-tester").Shape<{
7
+ type: import("object-shape-tester").Shape<import("@sinclair/typebox").TUnsafe<"empty">>;
8
+ }>;
9
+ /**
10
+ * A section that renders nothing.
11
+ *
12
+ * @category Section
13
+ */
14
+ export type StructuredRenderEmpty = typeof structuredRenderEmptyShape.runtimeType;
@@ -0,0 +1,9 @@
1
+ import { defineShape, exactShape } from 'object-shape-tester';
2
+ /**
3
+ * Shape definition for {@link StructuredRenderEmpty}.
4
+ *
5
+ * @category Internal
6
+ */
7
+ export const structuredRenderEmptyShape = defineShape({
8
+ type: exactShape('empty'),
9
+ });
@@ -0,0 +1,25 @@
1
+ import { type RenderOptions } from '../../render/render-types.js';
2
+ /**
3
+ * Shape definition for {@link StructuredRenderIcon}.
4
+ *
5
+ * @category Internal
6
+ */
7
+ export declare const structuredRenderIconShape: import("object-shape-tester").Shape<{
8
+ type: import("object-shape-tester").Shape<import("@sinclair/typebox").TUnsafe<"icon">>;
9
+ iconKey: string;
10
+ strokeColor: import("object-shape-tester").Shape<import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TString | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>>;
11
+ fillColor: import("object-shape-tester").Shape<import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TString | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>>;
12
+ strokeWidth: import("object-shape-tester").Shape<import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TString | import("@sinclair/typebox").TNumber)[]>)[]>>>;
13
+ }>;
14
+ /**
15
+ * A section that renders an icon in HTML.
16
+ *
17
+ * @category Section
18
+ */
19
+ export type StructuredRenderIcon = typeof structuredRenderIconShape.runtimeType;
20
+ /**
21
+ * Create a Colored Vira icon from {@link StructuredRenderIcon}.
22
+ *
23
+ * @category Internal
24
+ */
25
+ export declare function createStructuredRenderIcon(iconSection: Readonly<StructuredRenderIcon>, { icons }: Readonly<Pick<RenderOptions, 'icons'>>): import("vira").ViraIconSvg | undefined;
@@ -0,0 +1,40 @@
1
+ import { check } from '@augment-vir/assert';
2
+ import { addSuffix } from '@augment-vir/common';
3
+ import { defineShape, exactShape, nullableShape, unionShape } from 'object-shape-tester';
4
+ import { createColoredIcon } from 'vira';
5
+ /**
6
+ * Shape definition for {@link StructuredRenderIcon}.
7
+ *
8
+ * @category Internal
9
+ */
10
+ export const structuredRenderIconShape = defineShape({
11
+ type: exactShape('icon'),
12
+ iconKey: '',
13
+ strokeColor: nullableShape(''),
14
+ fillColor: nullableShape(''),
15
+ strokeWidth: nullableShape(unionShape('', -1)),
16
+ });
17
+ /**
18
+ * Create a Colored Vira icon from {@link StructuredRenderIcon}.
19
+ *
20
+ * @category Internal
21
+ */
22
+ export function createStructuredRenderIcon(iconSection, { icons }) {
23
+ const icon = icons[iconSection.iconKey];
24
+ if (!icon) {
25
+ return undefined;
26
+ }
27
+ const coloredIcon = createColoredIcon(icon, {
28
+ 'vira-icon-fill-color': iconSection.fillColor || undefined,
29
+ 'vira-icon-stroke-color': iconSection.strokeColor || undefined,
30
+ 'vira-icon-stroke-width': check.isString(iconSection.strokeWidth)
31
+ ? iconSection.strokeWidth
32
+ : check.isNumber(iconSection.strokeWidth)
33
+ ? addSuffix({
34
+ value: iconSection.strokeWidth,
35
+ suffix: 'px',
36
+ })
37
+ : undefined,
38
+ });
39
+ return coloredIcon;
40
+ }
@@ -0,0 +1,29 @@
1
+ /**
2
+ * Shape definition for {@link StructuredRenderInlineCode}.
3
+ *
4
+ * @category Internal
5
+ */
6
+ export declare const structuredRenderInlineCodeShape: import("object-shape-tester").Shape<{
7
+ type: import("object-shape-tester").Shape<import("@sinclair/typebox").TUnsafe<"inlineCode">>;
8
+ sectionTitle: import("object-shape-tester").Shape<import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TString | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>>;
9
+ sources: import("object-shape-tester").Shape<import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TArray<import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TObject<{
10
+ type: import("@sinclair/typebox").TUnsafe<"source">;
11
+ pageNumbers: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TArray<import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNumber | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>>)[]>>;
12
+ fileName: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TString | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>;
13
+ fileBoundingBoxes: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TArray<import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TObject<{
14
+ x1: import("@sinclair/typebox").TNumber;
15
+ y1: import("@sinclair/typebox").TNumber;
16
+ x2: import("@sinclair/typebox").TNumber;
17
+ y2: import("@sinclair/typebox").TNumber;
18
+ }>)[]>>>)[]>>;
19
+ quote: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TString | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>;
20
+ }>)[]>>>)[]>>>;
21
+ } & {
22
+ code: string;
23
+ }>;
24
+ /**
25
+ * A section that renders inline code.
26
+ *
27
+ * @category Section
28
+ */
29
+ export type StructuredRenderInlineCode = typeof structuredRenderInlineCodeShape.runtimeType;
@@ -0,0 +1,9 @@
1
+ import { createStructuredRenderSection } from '../create-section.js';
2
+ /**
3
+ * Shape definition for {@link StructuredRenderInlineCode}.
4
+ *
5
+ * @category Internal
6
+ */
7
+ export const structuredRenderInlineCodeShape = createStructuredRenderSection('inlineCode', {
8
+ code: '',
9
+ });
@@ -0,0 +1,169 @@
1
+ /**
2
+ * Shape definition for {@link StructuredRenderListItem}.
3
+ *
4
+ * @category Internal
5
+ */
6
+ export declare const structuredRenderListItemShape: import("object-shape-tester").Shape<{
7
+ content: import("object-shape-tester").Shape<import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TObject<{
8
+ type: import("@sinclair/typebox").TUnsafe<"empty">;
9
+ }> | import("@sinclair/typebox").TObject<{
10
+ type: import("@sinclair/typebox").TUnsafe<"tag">;
11
+ sectionTitle: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TString | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>;
12
+ sources: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TArray<import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TObject<{
13
+ type: import("@sinclair/typebox").TUnsafe<"source">;
14
+ pageNumbers: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TArray<import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNumber | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>>)[]>>;
15
+ fileName: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TString | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>;
16
+ fileBoundingBoxes: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TArray<import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TObject<{
17
+ x1: import("@sinclair/typebox").TNumber;
18
+ y1: import("@sinclair/typebox").TNumber;
19
+ x2: import("@sinclair/typebox").TNumber;
20
+ y2: import("@sinclair/typebox").TNumber;
21
+ }>)[]>>>)[]>>;
22
+ quote: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TString | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>;
23
+ }>)[]>>>)[]>>;
24
+ text: import("@sinclair/typebox").TString | import("@sinclair/typebox").TNumber | import("@sinclair/typebox").TBoolean | import("@sinclair/typebox").TSymbol | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TBigInt;
25
+ useBigTag: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TBoolean | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>;
26
+ color: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TObject<{
27
+ custom: import("@sinclair/typebox").TObject<{
28
+ backgroundColor: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TString | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>;
29
+ foregroundColor: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TString | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>;
30
+ }>;
31
+ }> | import("@sinclair/typebox").TObject<{
32
+ variant: import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TLiteral<import("vira").ViraColorVariant.Accent> | import("@sinclair/typebox").TLiteral<import("vira").ViraColorVariant.Plain> | import("@sinclair/typebox").TLiteral<import("vira").ViraColorVariant.Neutral> | import("@sinclair/typebox").TLiteral<import("vira").ViraColorVariant.Danger> | import("@sinclair/typebox").TLiteral<import("vira").ViraColorVariant.Warning> | import("@sinclair/typebox").TLiteral<import("vira").ViraColorVariant.Positive> | import("@sinclair/typebox").TLiteral<import("vira").ViraColorVariant.None>)[]>;
33
+ }>)[]>)[]>>;
34
+ }> | import("@sinclair/typebox").TObject<{
35
+ type: import("@sinclair/typebox").TUnsafe<"text">;
36
+ sectionTitle: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TString | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>;
37
+ sources: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TArray<import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TObject<{
38
+ type: import("@sinclair/typebox").TUnsafe<"source">;
39
+ pageNumbers: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TArray<import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNumber | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>>)[]>>;
40
+ fileName: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TString | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>;
41
+ fileBoundingBoxes: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TArray<import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TObject<{
42
+ x1: import("@sinclair/typebox").TNumber;
43
+ y1: import("@sinclair/typebox").TNumber;
44
+ x2: import("@sinclair/typebox").TNumber;
45
+ y2: import("@sinclair/typebox").TNumber;
46
+ }>)[]>>>)[]>>;
47
+ quote: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TString | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>;
48
+ }>)[]>>>)[]>>;
49
+ text: import("@sinclair/typebox").TString | import("@sinclair/typebox").TNumber | import("@sinclair/typebox").TBoolean | import("@sinclair/typebox").TSymbol | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TBigInt;
50
+ style: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TLiteral<import("./text.section.js").StructuredRenderTextStyle.Faint> | import("@sinclair/typebox").TLiteral<import("./text.section.js").StructuredRenderTextStyle.Small> | import("@sinclair/typebox").TLiteral<import("./text.section.js").StructuredRenderTextStyle.Bold>)[]>)[]>>;
51
+ icon: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TObject<{
52
+ type: import("@sinclair/typebox").TUnsafe<"icon">;
53
+ iconKey: import("@sinclair/typebox").TString;
54
+ strokeColor: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TString | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>;
55
+ fillColor: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TString | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>;
56
+ strokeWidth: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TString | import("@sinclair/typebox").TNumber)[]>)[]>>;
57
+ }>)[]>>;
58
+ }>)[]>)[]>>>;
59
+ /**
60
+ * Replaces the bullet. If a given icon key is not found in the supported list of icons, it is
61
+ * ignored.
62
+ */
63
+ icon: import("object-shape-tester").Shape<import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TObject<{
64
+ type: import("@sinclair/typebox").TUnsafe<"icon">;
65
+ iconKey: import("@sinclair/typebox").TString;
66
+ strokeColor: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TString | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>;
67
+ fillColor: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TString | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>;
68
+ strokeWidth: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TString | import("@sinclair/typebox").TNumber)[]>)[]>>;
69
+ }>)[]>>>;
70
+ }>;
71
+ /**
72
+ * Shape definition for {@link StructuredRenderList}.
73
+ *
74
+ * @category Internal
75
+ */
76
+ export declare const structuredRenderListShape: import("object-shape-tester").Shape<{
77
+ type: import("object-shape-tester").Shape<import("@sinclair/typebox").TUnsafe<"list">>;
78
+ sectionTitle: import("object-shape-tester").Shape<import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TString | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>>;
79
+ sources: import("object-shape-tester").Shape<import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TArray<import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TObject<{
80
+ type: import("@sinclair/typebox").TUnsafe<"source">;
81
+ pageNumbers: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TArray<import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNumber | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>>)[]>>;
82
+ fileName: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TString | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>;
83
+ fileBoundingBoxes: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TArray<import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TObject<{
84
+ x1: import("@sinclair/typebox").TNumber;
85
+ y1: import("@sinclair/typebox").TNumber;
86
+ x2: import("@sinclair/typebox").TNumber;
87
+ y2: import("@sinclair/typebox").TNumber;
88
+ }>)[]>>>)[]>>;
89
+ quote: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TString | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>;
90
+ }>)[]>>>)[]>>>;
91
+ } & {
92
+ items: import("object-shape-tester").Shape<{
93
+ content: import("object-shape-tester").Shape<import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TObject<{
94
+ type: import("@sinclair/typebox").TUnsafe<"empty">;
95
+ }> | import("@sinclair/typebox").TObject<{
96
+ type: import("@sinclair/typebox").TUnsafe<"tag">;
97
+ sectionTitle: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TString | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>;
98
+ sources: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TArray<import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TObject<{
99
+ type: import("@sinclair/typebox").TUnsafe<"source">;
100
+ pageNumbers: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TArray<import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNumber | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>>)[]>>;
101
+ fileName: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TString | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>;
102
+ fileBoundingBoxes: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TArray<import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TObject<{
103
+ x1: import("@sinclair/typebox").TNumber;
104
+ y1: import("@sinclair/typebox").TNumber;
105
+ x2: import("@sinclair/typebox").TNumber;
106
+ y2: import("@sinclair/typebox").TNumber;
107
+ }>)[]>>>)[]>>;
108
+ quote: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TString | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>;
109
+ }>)[]>>>)[]>>;
110
+ text: import("@sinclair/typebox").TString | import("@sinclair/typebox").TNumber | import("@sinclair/typebox").TBoolean | import("@sinclair/typebox").TSymbol | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TBigInt;
111
+ useBigTag: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TBoolean | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>;
112
+ color: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TObject<{
113
+ custom: import("@sinclair/typebox").TObject<{
114
+ backgroundColor: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TString | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>;
115
+ foregroundColor: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TString | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>;
116
+ }>;
117
+ }> | import("@sinclair/typebox").TObject<{
118
+ variant: import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TLiteral<import("vira").ViraColorVariant.Accent> | import("@sinclair/typebox").TLiteral<import("vira").ViraColorVariant.Plain> | import("@sinclair/typebox").TLiteral<import("vira").ViraColorVariant.Neutral> | import("@sinclair/typebox").TLiteral<import("vira").ViraColorVariant.Danger> | import("@sinclair/typebox").TLiteral<import("vira").ViraColorVariant.Warning> | import("@sinclair/typebox").TLiteral<import("vira").ViraColorVariant.Positive> | import("@sinclair/typebox").TLiteral<import("vira").ViraColorVariant.None>)[]>;
119
+ }>)[]>)[]>>;
120
+ }> | import("@sinclair/typebox").TObject<{
121
+ type: import("@sinclair/typebox").TUnsafe<"text">;
122
+ sectionTitle: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TString | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>;
123
+ sources: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TArray<import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TObject<{
124
+ type: import("@sinclair/typebox").TUnsafe<"source">;
125
+ pageNumbers: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TArray<import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNumber | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>>)[]>>;
126
+ fileName: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TString | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>;
127
+ fileBoundingBoxes: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TArray<import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TObject<{
128
+ x1: import("@sinclair/typebox").TNumber;
129
+ y1: import("@sinclair/typebox").TNumber;
130
+ x2: import("@sinclair/typebox").TNumber;
131
+ y2: import("@sinclair/typebox").TNumber;
132
+ }>)[]>>>)[]>>;
133
+ quote: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TString | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>;
134
+ }>)[]>>>)[]>>;
135
+ text: import("@sinclair/typebox").TString | import("@sinclair/typebox").TNumber | import("@sinclair/typebox").TBoolean | import("@sinclair/typebox").TSymbol | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TBigInt;
136
+ style: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TLiteral<import("./text.section.js").StructuredRenderTextStyle.Faint> | import("@sinclair/typebox").TLiteral<import("./text.section.js").StructuredRenderTextStyle.Small> | import("@sinclair/typebox").TLiteral<import("./text.section.js").StructuredRenderTextStyle.Bold>)[]>)[]>>;
137
+ icon: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TObject<{
138
+ type: import("@sinclair/typebox").TUnsafe<"icon">;
139
+ iconKey: import("@sinclair/typebox").TString;
140
+ strokeColor: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TString | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>;
141
+ fillColor: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TString | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>;
142
+ strokeWidth: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TString | import("@sinclair/typebox").TNumber)[]>)[]>>;
143
+ }>)[]>>;
144
+ }>)[]>)[]>>>;
145
+ /**
146
+ * Replaces the bullet. If a given icon key is not found in the supported list of icons, it is
147
+ * ignored.
148
+ */
149
+ icon: import("object-shape-tester").Shape<import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TObject<{
150
+ type: import("@sinclair/typebox").TUnsafe<"icon">;
151
+ iconKey: import("@sinclair/typebox").TString;
152
+ strokeColor: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TString | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>;
153
+ fillColor: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TString | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>;
154
+ strokeWidth: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TString | import("@sinclair/typebox").TNumber)[]>)[]>>;
155
+ }>)[]>>>;
156
+ }>[];
157
+ }>;
158
+ /**
159
+ * A single item within a {@link StructuredRenderList}.
160
+ *
161
+ * @category Internal
162
+ */
163
+ export type StructuredRenderListItem = typeof structuredRenderListItemShape.runtimeType;
164
+ /**
165
+ * A section that renders a list of items.
166
+ *
167
+ * @category Section
168
+ */
169
+ export type StructuredRenderList = typeof structuredRenderListShape.runtimeType;
@@ -0,0 +1,29 @@
1
+ import { defineShape, nullableShape, unionShape } from 'object-shape-tester';
2
+ import { createStructuredRenderSection } from '../create-section.js';
3
+ import { structuredRenderEmptyShape } from './empty.section.js';
4
+ import { structuredRenderIconShape } from './icon.section.js';
5
+ import { structuredRenderTagShape } from './tag.section.js';
6
+ import { structuredRenderTextShape } from './text.section.js';
7
+ /**
8
+ * Shape definition for {@link StructuredRenderListItem}.
9
+ *
10
+ * @category Internal
11
+ */
12
+ export const structuredRenderListItemShape = defineShape({
13
+ content: nullableShape(unionShape(structuredRenderTextShape, structuredRenderTagShape, structuredRenderEmptyShape)),
14
+ /**
15
+ * Replaces the bullet. If a given icon key is not found in the supported list of icons, it is
16
+ * ignored.
17
+ */
18
+ icon: nullableShape(structuredRenderIconShape),
19
+ });
20
+ /**
21
+ * Shape definition for {@link StructuredRenderList}.
22
+ *
23
+ * @category Internal
24
+ */
25
+ export const structuredRenderListShape = createStructuredRenderSection('list', {
26
+ items: [
27
+ structuredRenderListItemShape,
28
+ ],
29
+ });
@@ -0,0 +1,29 @@
1
+ /**
2
+ * Shape definition for {@link RenderDataMarkdown}.
3
+ *
4
+ * @category Internal
5
+ */
6
+ export declare const renderDataMarkdownShape: import("object-shape-tester").Shape<{
7
+ type: import("object-shape-tester").Shape<import("@sinclair/typebox").TUnsafe<"markdown">>;
8
+ sectionTitle: import("object-shape-tester").Shape<import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TString | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>>;
9
+ sources: import("object-shape-tester").Shape<import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TArray<import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TObject<{
10
+ type: import("@sinclair/typebox").TUnsafe<"source">;
11
+ pageNumbers: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TArray<import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNumber | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>>)[]>>;
12
+ fileName: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TString | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>;
13
+ fileBoundingBoxes: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TArray<import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TObject<{
14
+ x1: import("@sinclair/typebox").TNumber;
15
+ y1: import("@sinclair/typebox").TNumber;
16
+ x2: import("@sinclair/typebox").TNumber;
17
+ y2: import("@sinclair/typebox").TNumber;
18
+ }>)[]>>>)[]>>;
19
+ quote: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TString | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>;
20
+ }>)[]>>>)[]>>>;
21
+ } & {
22
+ markdown: string;
23
+ }>;
24
+ /**
25
+ * A section that renders markdown content.
26
+ *
27
+ * @category Section
28
+ */
29
+ export type RenderDataMarkdown = typeof renderDataMarkdownShape.runtimeType;
@@ -0,0 +1,9 @@
1
+ import { createStructuredRenderSection } from '../create-section.js';
2
+ /**
3
+ * Shape definition for {@link RenderDataMarkdown}.
4
+ *
5
+ * @category Internal
6
+ */
7
+ export const renderDataMarkdownShape = createStructuredRenderSection('markdown', {
8
+ markdown: '',
9
+ });
@@ -0,0 +1,14 @@
1
+ /**
2
+ * Shape definition for {@link StructuredRenderProcessing}.
3
+ *
4
+ * @category Internal
5
+ */
6
+ export declare const structuredRenderProcessingShape: import("object-shape-tester").Shape<{
7
+ type: import("object-shape-tester").Shape<import("@sinclair/typebox").TUnsafe<"processing">>;
8
+ }>;
9
+ /**
10
+ * A section that renders a processing indicator in HTML.
11
+ *
12
+ * @category Section
13
+ */
14
+ export type StructuredRenderProcessing = typeof structuredRenderProcessingShape.runtimeType;
@@ -0,0 +1,9 @@
1
+ import { defineShape, exactShape } from 'object-shape-tester';
2
+ /**
3
+ * Shape definition for {@link StructuredRenderProcessing}.
4
+ *
5
+ * @category Internal
6
+ */
7
+ export const structuredRenderProcessingShape = defineShape({
8
+ type: exactShape('processing'),
9
+ });
@@ -0,0 +1,59 @@
1
+ import { type AtLeastTuple, type MaybeArray } from '@augment-vir/common';
2
+ /**
3
+ * Shape definition for {@link StructuredRenderFileBoundingBox}.
4
+ *
5
+ * @category Internal
6
+ */
7
+ export declare const structuredRenderFileBoundingBoxShape: import("object-shape-tester").Shape<{
8
+ x1: number;
9
+ y1: number;
10
+ x2: number;
11
+ y2: number;
12
+ }>;
13
+ /**
14
+ * A bounding box within a source file.
15
+ *
16
+ * @category Section
17
+ */
18
+ export type StructuredRenderFileBoundingBox = typeof structuredRenderFileBoundingBoxShape.runtimeType;
19
+ /**
20
+ * A shape definition for structured render sources. Any structured render can have sources.
21
+ *
22
+ * @category Internal
23
+ */
24
+ export declare const structuredRenderSourceShape: import("object-shape-tester").Shape<{
25
+ type: import("object-shape-tester").Shape<import("@sinclair/typebox").TUnsafe<"source">>;
26
+ pageNumbers: import("object-shape-tester").Shape<import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TArray<import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNumber | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>>)[]>>>;
27
+ fileName: import("object-shape-tester").Shape<import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TString | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>>;
28
+ fileBoundingBoxes: import("object-shape-tester").Shape<import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TArray<import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TObject<{
29
+ x1: import("@sinclair/typebox").TNumber;
30
+ y1: import("@sinclair/typebox").TNumber;
31
+ x2: import("@sinclair/typebox").TNumber;
32
+ y2: import("@sinclair/typebox").TNumber;
33
+ }>)[]>>>)[]>>>;
34
+ quote: import("object-shape-tester").Shape<import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TString | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>>;
35
+ }>;
36
+ /**
37
+ * A section that renders a source reference.
38
+ *
39
+ * @category Section
40
+ */
41
+ export type StructuredRenderSource = typeof structuredRenderSourceShape.runtimeType;
42
+ /**
43
+ * All acceptable configurations of a source section that can be rendered.
44
+ *
45
+ * @category Internal
46
+ */
47
+ export type SourcesInput = Readonly<MaybeArray<StructuredRenderSource | undefined | null>>;
48
+ /**
49
+ * Handle all the possible values for sources and combine them into an easy to use return type.
50
+ *
51
+ * @category Internal
52
+ */
53
+ export declare function createCleanSources(rawSources: SourcesInput): undefined | AtLeastTuple<StructuredRenderSource, 1>;
54
+ /**
55
+ * Check if a source section has any content.
56
+ *
57
+ * @category Internal
58
+ */
59
+ export declare function sourceHasContent(section: Readonly<StructuredRenderSource> | undefined | null): section is NonNullable<typeof section>;