structured-render 0.0.0 → 0.0.1

package/dist/structured-render-data/sections/table.section.js

@@ -0,0 +1,99 @@
+import { enumShape, nullableShape, recordShape, unionShape } from 'object-shape-tester';
+import { createStructuredRenderSection } from '../create-section.js';
+import { structuredRenderEmptyShape } from './empty.section.js';
+import { structuredRenderInlineCodeShape } from './inline-code.section.js';
+import { structuredRenderListShape } from './list.section.js';
+import { renderDataMarkdownShape } from './markdown.section.js';
+import { structuredRenderProcessingShape } from './processing.section.js';
+import { structuredRenderSourceShape } from './source.section.js';
+import { structuredRenderTagShape } from './tag.section.js';
+import { structuredRenderTextShape } from './text.section.js';
+/**
+ * Footer alignment options for {@link StructuredRenderTable}.
+ *
+ * @category Options
+ * @default StructuredRenderTableFooterAlignment.Left
+ */
+export var StructuredRenderTableFooterAlignment;
+(function (StructuredRenderTableFooterAlignment) {
+    /** @default */
+    StructuredRenderTableFooterAlignment["Left"] = "left";
+    StructuredRenderTableFooterAlignment["Right"] = "right";
+})(StructuredRenderTableFooterAlignment || (StructuredRenderTableFooterAlignment = {}));
+/**
+ * Controls which direction cells render for {@link StructuredRenderTable}.
+ *
+ * @category Options
+ */
+export var StructuredRenderCellDirection;
+(function (StructuredRenderCellDirection) {
+    /**
+     * Each cell in a table entry is rendered to the _right_ of the previous one; the cells run
+     * horizontally and increase the table's _width_. Headers run along the first row. Each table
+     * entry creates a new _row_.
+     */
+    StructuredRenderCellDirection["Horizontal"] = "horizontal";
+    /**
+     * Each cell in a table entry is rendered _below_ the previous one; the cells run vertically and
+     * increase the table's _height_. Headers run down the first column. Each table entry creates a
+     * new _column_.
+     */
+    StructuredRenderCellDirection["Vertical"] = "vertical";
+})(StructuredRenderCellDirection || (StructuredRenderCellDirection = {}));
+/**
+ * All section shapes allowed inside {@link StructuredRenderTable} cells.
+ *
+ * @category Internal
+ */
+export const structuredRenderShapesAllowedInTableShape = unionShape(structuredRenderTextShape, structuredRenderInlineCodeShape, renderDataMarkdownShape, structuredRenderTagShape, structuredRenderListShape, structuredRenderEmptyShape, structuredRenderProcessingShape);
+/**
+ * Shape definition for {@link StructuredRenderTable}.
+ *
+ * @category Internal
+ */
+export const structuredRenderTableShape = createStructuredRenderSection('table', {
+    direction: enumShape(StructuredRenderCellDirection),
+    headers: [
+        {
+            key: '',
+            text: nullableShape(structuredRenderTextShape),
+            /**
+             * If `true`, all data associated with this header (the column / row) is not rendered at
+             * all.
+             */
+            hidden: nullableShape(false),
+        },
+    ],
+    entries: [
+        {
+            data: recordShape({
+                keys: '',
+                values: unionShape(nullableShape(structuredRenderShapesAllowedInTableShape), [
+                    nullableShape(structuredRenderShapesAllowedInTableShape),
+                ]),
+            }),
+            sources: nullableShape([nullableShape(structuredRenderSourceShape)]),
+        },
+    ],
+    footerRows: nullableShape([
+        {
+            /** @default StructuredRenderTableFooterAlignment.Left */
+            alignment: nullableShape(enumShape(StructuredRenderTableFooterAlignment)),
+            cells: unionShape(nullableShape(structuredRenderShapesAllowedInTableShape), [
+                nullableShape(structuredRenderShapesAllowedInTableShape),
+            ]),
+        },
+    ]),
+});
+/**
+ * A helper for defining a {@link StructuredRenderTable} instance.
+ *
+ * @category Util
+ */
+export function createRenderDataTable(headers, entries, footerRows) {
+    return {
+        headers,
+        entries,
+        footerRows,
+    };
+}

package/dist/structured-render-data/sections/tag.section.d.ts

@@ -0,0 +1,39 @@
+import { ViraColorVariant } from 'vira';
+/**
+ * Shape definition for {@link StructuredRenderTag}.
+ *
+ * @category Internal
+ */
+export declare const structuredRenderTagShape: import("object-shape-tester").Shape<{
+    type: import("object-shape-tester").Shape<import("@sinclair/typebox").TUnsafe<"tag">>;
+    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)[]>>>;
+    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<{
+        type: import("@sinclair/typebox").TUnsafe<"source">;
+        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)[]>>>)[]>>;
+        fileName: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TString | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>;
+        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<{
+            x1: import("@sinclair/typebox").TNumber;
+            y1: import("@sinclair/typebox").TNumber;
+            x2: import("@sinclair/typebox").TNumber;
+            y2: import("@sinclair/typebox").TNumber;
+        }>)[]>>>)[]>>;
+        quote: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TString | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>;
+    }>)[]>>>)[]>>>;
+} & {
+    text: import("object-shape-tester").Shape<import("type-fest").Primitive>;
+    useBigTag: import("object-shape-tester").Shape<import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TBoolean | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>>;
+    color: 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<{
+        custom: import("@sinclair/typebox").TObject<{
+            backgroundColor: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TString | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>;
+            foregroundColor: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TString | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>;
+        }>;
+    }> | import("@sinclair/typebox").TObject<{
+        variant: import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TLiteral<ViraColorVariant.Accent> | import("@sinclair/typebox").TLiteral<ViraColorVariant.Plain> | import("@sinclair/typebox").TLiteral<ViraColorVariant.Neutral> | import("@sinclair/typebox").TLiteral<ViraColorVariant.Danger> | import("@sinclair/typebox").TLiteral<ViraColorVariant.Warning> | import("@sinclair/typebox").TLiteral<ViraColorVariant.Positive> | import("@sinclair/typebox").TLiteral<ViraColorVariant.None>)[]>;
+    }>)[]>)[]>>>;
+}>;
+/**
+ * A section that renders a tag.
+ *
+ * @category Section
+ */
+export type StructuredRenderTag = typeof structuredRenderTagShape.runtimeType;

package/dist/structured-render-data/sections/tag.section.js

@@ -0,0 +1,20 @@
+import { enumShape, nullableShape, partialShape, primitiveShape, unionShape, } from 'object-shape-tester';
+import { ViraColorVariant } from 'vira';
+import { createStructuredRenderSection } from '../create-section.js';
+/**
+ * Shape definition for {@link StructuredRenderTag}.
+ *
+ * @category Internal
+ */
+export const structuredRenderTagShape = createStructuredRenderSection('tag', {
+    text: primitiveShape(''),
+    useBigTag: nullableShape(false),
+    color: nullableShape(unionShape({
+        custom: partialShape({
+            backgroundColor: nullableShape(''),
+            foregroundColor: nullableShape(''),
+        }),
+    }, {
+        variant: enumShape(ViraColorVariant),
+    })),
+});

package/dist/structured-render-data/sections/text.section.d.ts

@@ -0,0 +1,48 @@
+/**
+ * Style options for {@link StructuredRenderText}.
+ *
+ * @category Options
+ */
+export declare enum StructuredRenderTextStyle {
+    Faint = "faint",
+    Small = "small",
+    Bold = "bold"
+}
+/**
+ * Shape definition for {@link StructuredRenderText}.
+ *
+ * @category Internal
+ */
+export declare const structuredRenderTextShape: import("object-shape-tester").Shape<{
+    type: import("object-shape-tester").Shape<import("@sinclair/typebox").TUnsafe<"text">>;
+    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)[]>>>;
+    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<{
+        type: import("@sinclair/typebox").TUnsafe<"source">;
+        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)[]>>>)[]>>;
+        fileName: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TString | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>;
+        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<{
+            x1: import("@sinclair/typebox").TNumber;
+            y1: import("@sinclair/typebox").TNumber;
+            x2: import("@sinclair/typebox").TNumber;
+            y2: import("@sinclair/typebox").TNumber;
+        }>)[]>>>)[]>>;
+        quote: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TString | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>;
+    }>)[]>>>)[]>>>;
+} & {
+    text: import("object-shape-tester").Shape<import("type-fest").Primitive>;
+    style: 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").TLiteral<StructuredRenderTextStyle.Faint> | import("@sinclair/typebox").TLiteral<StructuredRenderTextStyle.Small> | import("@sinclair/typebox").TLiteral<StructuredRenderTextStyle.Bold>)[]>)[]>>>;
+    /** Rendered before the text. */
+    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<{
+        type: import("@sinclair/typebox").TUnsafe<"icon">;
+        iconKey: import("@sinclair/typebox").TString;
+        strokeColor: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TString | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>;
+        fillColor: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TString | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>;
+        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)[]>)[]>>;
+    }>)[]>>>;
+}>;
+/**
+ * A section that renders text.
+ *
+ * @category Section
+ */
+export type StructuredRenderText = typeof structuredRenderTextShape.runtimeType;

package/dist/structured-render-data/sections/text.section.js

@@ -0,0 +1,25 @@
+import { enumShape, nullableShape, primitiveShape } from 'object-shape-tester';
+import { createStructuredRenderSection } from '../create-section.js';
+import { structuredRenderIconShape } from './icon.section.js';
+/**
+ * Style options for {@link StructuredRenderText}.
+ *
+ * @category Options
+ */
+export var StructuredRenderTextStyle;
+(function (StructuredRenderTextStyle) {
+    StructuredRenderTextStyle["Faint"] = "faint";
+    StructuredRenderTextStyle["Small"] = "small";
+    StructuredRenderTextStyle["Bold"] = "bold";
+})(StructuredRenderTextStyle || (StructuredRenderTextStyle = {}));
+/**
+ * Shape definition for {@link StructuredRenderText}.
+ *
+ * @category Internal
+ */
+export const structuredRenderTextShape = createStructuredRenderSection('text', {
+    text: primitiveShape(''),
+    style: nullableShape(enumShape(StructuredRenderTextStyle)),
+    /** Rendered before the text. */
+    icon: nullableShape(structuredRenderIconShape),
+});