@texuli/blocks 0.0.0-stage → 0.1.0-next.0

package/dist/data/ChartBlockView.svelte.d.ts

@@ -0,0 +1,10 @@
+/// <reference path="../css-modules.d.ts" />
+import type { Component } from 'svelte';
+import type { ChartBlock } from '../core/index.js';
+type $$ComponentProps = {
+    block: ChartBlock;
+    mode?: 'light' | 'dark';
+};
+declare const ChartBlockView: Component<$$ComponentProps, {}, "">;
+type ChartBlockView = ReturnType<typeof ChartBlockView>;
+export default ChartBlockView;

package/dist/data/DataBlockView.svelte

@@ -0,0 +1,109 @@
+<script lang="ts">
+import { Stat } from 'texuli/stat';
+import {
+  Table,
+  TableBody,
+  TableCaption,
+  TableCell,
+  TableEmpty,
+  TableHead,
+  TableHeader,
+  TableRow,
+} from 'texuli/table';
+import ChartBlockView from './ChartBlockView.svelte';
+import { checkDataBlock } from './check.js';
+import type { DataBlockViewProps } from './family.js';
+import { resolveDataBlockLabels } from './labels.js';
+
+let { block, labels, oninvalid, mode = 'light' }: DataBlockViewProps = $props();
+
+const check = $derived(checkDataBlock(block));
+const text = $derived(resolveDataBlockLabels(labels));
+
+$effect(() => {
+  if (!check.ok) oninvalid?.(check.issues);
+});
+
+function cellText(value: string | number | null): string {
+  if (value === null) return '—';
+  return typeof value === 'number'
+    ? new Intl.NumberFormat(undefined, { maximumFractionDigits: 2 }).format(value)
+    : value;
+}
+</script>
+
+{#if !check.ok}
+  <p class="tx-block tx-block-invalid" role="note" data-tx-block="invalid">{text.invalid}</p>
+{:else}
+  {@const b = check.block}
+  {#if b.type === 'table'}
+    <div class="tx-block tx-block-table" data-tx-block="table" data-tone={b.tone}>
+      <Table>
+        {#if b.caption}
+          <TableCaption>{b.caption}</TableCaption>
+        {/if}
+        <TableHeader>
+          <TableRow>
+            {#each b.columns as column (column.id)}
+              <TableHead>{column.label}</TableHead>
+            {/each}
+          </TableRow>
+        </TableHeader>
+        <TableBody>
+          {#if b.rows.length === 0}
+            <TableEmpty colspan={b.columns.length}>{text.emptyTable}</TableEmpty>
+          {:else}
+            {#each b.rows as row, ri (ri)}
+              <TableRow>
+                {#each b.columns as column (column.id)}
+                  <TableCell>{cellText(row[column.id] ?? null)}</TableCell>
+                {/each}
+              </TableRow>
+            {/each}
+          {/if}
+        </TableBody>
+      </Table>
+    </div>
+  {:else if b.type === 'stat' || b.type === 'kpi'}
+    <div
+      class="tx-block"
+      class:tx-block-stat={b.type === 'stat'}
+      class:tx-block-kpi={b.type === 'kpi'}
+      data-tx-block={b.type}
+      data-tone={b.tone}
+      role="group"
+      aria-label={b.type === 'kpi' ? 'Key performance indicators' : 'Statistics'}
+    >
+      <div class="tx-stat-grid">
+        {#each b.items as item, i (i)}
+          <Stat label={item.label} value={item.value} hint={item.hint} delta={item.delta} />
+        {/each}
+      </div>
+    </div>
+  {:else}
+    <div class="tx-block tx-block-chart" data-tx-block="chart" data-tone={b.tone}>
+      <ChartBlockView block={b} {mode} />
+    </div>
+  {/if}
+{/if}
+
+<style>
+  .tx-block {
+    margin: 0;
+    overflow-wrap: anywhere;
+  }
+  .tx-block-invalid {
+    color: var(--tx-muted-foreground, GrayText);
+    font-size: 0.875rem;
+  }
+  .tx-stat-grid {
+    display: grid;
+    grid-template-columns: repeat(auto-fit, minmax(min(100%, 10rem), 1fr));
+    gap: 0.75rem;
+  }
+  .tx-block-table,
+  .tx-block-chart {
+    max-inline-size: 100%;
+    overflow-x: auto;
+  }
+</style>

package/dist/data/DataBlockView.svelte.d.ts

@@ -0,0 +1,5 @@
+/// <reference path="../css-modules.d.ts" />
+import type { DataBlockViewProps } from './family.js';
+declare const DataBlockView: import("svelte").Component<DataBlockViewProps, {}, "">;
+type DataBlockView = ReturnType<typeof DataBlockView>;
+export default DataBlockView;

package/dist/data/check.d.ts

@@ -0,0 +1,10 @@
+import type { FieldIssue } from '../core/schema/primitives.js';
+import type { DataFamilyBlock } from './engine.js';
+export type DataBlockCheck = {
+    ok: true;
+    block: DataFamilyBlock;
+} | {
+    ok: false;
+    issues: FieldIssue[];
+};
+export declare function checkDataBlock(value: unknown): DataBlockCheck;

package/dist/data/check.js

@@ -0,0 +1,9 @@
+import { parseFamilyBlock } from "../core/schema/parse-family.js";
+import { parseDataBlock } from "./schema.js";
+export function checkDataBlock(value) {
+    // Only this family's parser: the renderer does not bundle every family's rules.
+    const parsed = parseFamilyBlock(value, [parseDataBlock], 'data');
+    if (!parsed.success)
+        return { ok: false, issues: parsed.issues };
+    return { ok: true, block: parsed.data };
+}

package/dist/data/engine.d.ts

@@ -0,0 +1,18 @@
+/**
+ * `@texuli/blocks/data/engine` — Svelte-free table/stat/kpi/chart parsers and labels.
+ */
+import type { Block, ChartBlock, FieldIssue, KpiBlock, StatBlock, TableBlock } from '../core/index.js';
+import type { DataBlockLabelOverrides } from './labels.js';
+export { checkDataBlock, type DataBlockCheck } from './check.js';
+export { type DataBlockLabelOverrides, type DataBlockLabels, DEFAULT_DATA_BLOCK_LABELS, resolveDataBlockLabels, } from './labels.js';
+export { CHART_KINDS, type ChartBlock, type ChartHeatCell, type ChartKind, type ChartScatterPoint, type ChartSeries, type ChartSeriesPoint, type DataBlock, type DataBlockType, type KpiBlock, type KpiItem, parseChartBlock, parseDataBlock, parseKpiBlock, parseStatBlock, parseTableBlock, type StatBlock, type StatItem, type TableBlock, type TableCellValue, type TableColumn, type TableRow, } from './schema.js';
+export declare const DATA_BLOCK_TYPES: readonly ["table", "stat", "kpi", "chart"];
+export type DataFamilyBlockType = (typeof DATA_BLOCK_TYPES)[number];
+export type DataFamilyBlock = TableBlock | StatBlock | KpiBlock | ChartBlock;
+export declare function isDataFamilyBlock(block: Block): block is DataFamilyBlock;
+export interface DataBlockViewProps {
+    block: unknown;
+    labels?: DataBlockLabelOverrides;
+    oninvalid?: (issues: FieldIssue[]) => void;
+    mode?: 'light' | 'dark';
+}

package/dist/data/engine.js

@@ -0,0 +1,10 @@
+/**
+ * `@texuli/blocks/data/engine` — Svelte-free table/stat/kpi/chart parsers and labels.
+ */
+export { checkDataBlock } from "./check.js";
+export { DEFAULT_DATA_BLOCK_LABELS, resolveDataBlockLabels, } from "./labels.js";
+export { CHART_KINDS, parseChartBlock, parseDataBlock, parseKpiBlock, parseStatBlock, parseTableBlock, } from "./schema.js";
+export const DATA_BLOCK_TYPES = ['table', 'stat', 'kpi', 'chart'];
+export function isDataFamilyBlock(block) {
+    return DATA_BLOCK_TYPES.includes(block.type);
+}

package/dist/data/family.d.ts

@@ -0,0 +1,6 @@
+import type { Component } from 'svelte';
+import type { DataBlockViewProps } from './engine.js';
+export { DATA_BLOCK_TYPES, type DataBlockViewProps, type DataFamilyBlock, type DataFamilyBlockType, isDataFamilyBlock, } from './engine.js';
+export declare function loadDataFamily(): Promise<{
+    default: Component<DataBlockViewProps>;
+}>;

package/dist/data/family.js

@@ -0,0 +1,4 @@
+export { DATA_BLOCK_TYPES, isDataFamilyBlock, } from "./engine.js";
+export function loadDataFamily() {
+    return import('./DataBlockView.svelte');
+}

package/dist/data/index.d.ts

@@ -0,0 +1,9 @@
+/// <reference path="../css-modules.d.ts" />
+/**
+ * `@texuli/blocks` data family (T-blocks-data): table, stat, kpi and chart.
+ * Renderers load through `loadDataFamily()` or `@texuli/blocks/data/renderers`.
+ */
+export { checkDataBlock, type DataBlockCheck } from './check.js';
+export { DATA_BLOCK_TYPES, type DataBlockViewProps, type DataFamilyBlock, type DataFamilyBlockType, isDataFamilyBlock, loadDataFamily, } from './family.js';
+export { type DataBlockLabelOverrides, type DataBlockLabels, DEFAULT_DATA_BLOCK_LABELS, resolveDataBlockLabels, } from './labels.js';
+export { CHART_KINDS, type ChartBlock, type ChartHeatCell, type ChartKind, type ChartScatterPoint, type ChartSeries, type ChartSeriesPoint, type DataBlock, type DataBlockType, type KpiBlock, type KpiItem, parseChartBlock, parseDataBlock, parseKpiBlock, parseStatBlock, parseTableBlock, type StatBlock, type StatItem, type TableBlock, type TableCellValue, type TableColumn, type TableRow, } from './schema.js';

package/dist/data/index.js

@@ -0,0 +1,8 @@
+/**
+ * `@texuli/blocks` data family (T-blocks-data): table, stat, kpi and chart.
+ * Renderers load through `loadDataFamily()` or `@texuli/blocks/data/renderers`.
+ */
+export { checkDataBlock } from "./check.js";
+export { DATA_BLOCK_TYPES, isDataFamilyBlock, loadDataFamily, } from "./family.js";
+export { DEFAULT_DATA_BLOCK_LABELS, resolveDataBlockLabels, } from "./labels.js";
+export { CHART_KINDS, parseChartBlock, parseDataBlock, parseKpiBlock, parseStatBlock, parseTableBlock, } from "./schema.js";

package/dist/data/labels.d.ts

@@ -0,0 +1,8 @@
+export interface DataBlockLabels {
+    invalid: string;
+    emptyTable: string;
+    tableSummary: string;
+}
+export type DataBlockLabelOverrides = Partial<DataBlockLabels>;
+export declare const DEFAULT_DATA_BLOCK_LABELS: DataBlockLabels;
+export declare function resolveDataBlockLabels(overrides?: DataBlockLabelOverrides): DataBlockLabels;

package/dist/data/labels.js

@@ -0,0 +1,8 @@
+export const DEFAULT_DATA_BLOCK_LABELS = {
+    invalid: 'This block could not be shown.',
+    emptyTable: 'No rows',
+    tableSummary: 'Data table',
+};
+export function resolveDataBlockLabels(overrides) {
+    return { ...DEFAULT_DATA_BLOCK_LABELS, ...overrides };
+}

package/dist/data/renderers.d.ts

@@ -0,0 +1,2 @@
+export { default as ChartBlockView } from './ChartBlockView.svelte';
+export { default as DataBlockView } from './DataBlockView.svelte';

package/dist/data/renderers.js

@@ -0,0 +1,2 @@
+export { default as ChartBlockView } from './ChartBlockView.svelte';
+export { default as DataBlockView } from './DataBlockView.svelte';

package/dist/data/schema.d.ts

@@ -0,0 +1,84 @@
+/**
+ * Data-family block shapes and parsers (table, stat, chart, kpi).
+ * Wired into the core `safeParseBlock` switch via `parseDataBlock`.
+ */
+import { type BlockBase, type ParseResult } from '../core/schema/primitives.js';
+import { type BlockTone } from '../core/schema/vocabulary.js';
+export type TableColumn = {
+    id: string;
+    label: string;
+};
+export type TableCellValue = string | number | null;
+export type TableRow = Record<string, TableCellValue>;
+export type TableBlock = BlockBase & {
+    type: 'table';
+    caption?: string;
+    columns: TableColumn[];
+    rows: TableRow[];
+};
+export type StatItem = {
+    label: string;
+    value: string;
+    hint?: string;
+    delta?: string;
+    tone?: BlockTone;
+};
+export type StatBlock = BlockBase & {
+    type: 'stat';
+    items: StatItem[];
+};
+export type KpiItem = {
+    label: string;
+    value: string;
+    hint?: string;
+    delta?: string;
+    tone?: BlockTone;
+};
+export type KpiBlock = BlockBase & {
+    type: 'kpi';
+    items: KpiItem[];
+};
+export type ChartKind = 'line' | 'area' | 'bar' | 'stacked-bar' | 'heatmap' | 'scatter' | 'bubble';
+export type ChartSeriesPoint = {
+    x: string | number;
+    y: number | null;
+};
+export type ChartSeries = {
+    id: string;
+    label: string;
+    points: ChartSeriesPoint[];
+    color?: string;
+};
+export type ChartHeatCell = {
+    x: string;
+    y: string;
+    value: number;
+};
+export type ChartScatterPoint = {
+    id: string;
+    label: string;
+    x: number;
+    y: number;
+    r?: number;
+    seriesId?: string;
+};
+export type ChartBlock = BlockBase & {
+    type: 'chart';
+    kind: ChartKind;
+    title: string;
+    /** Accessible description (required). */
+    description: string;
+    series?: ChartSeries[];
+    cells?: ChartHeatCell[];
+    points?: ChartScatterPoint[];
+};
+export type DataBlock = TableBlock | StatBlock | KpiBlock | ChartBlock;
+export type DataBlockType = DataBlock['type'];
+export declare const DATA_BLOCK_TYPES: readonly ["table", "stat", "kpi", "chart"];
+export declare const CHART_KINDS: readonly ["line", "area", "bar", "stacked-bar", "heatmap", "scatter", "bubble"];
+export declare function parseTableBlock(record: Record<string, unknown>, path: (string | number)[], base: BlockBase): ParseResult<TableBlock>;
+export declare function parseStatBlock(record: Record<string, unknown>, path: (string | number)[], base: BlockBase): ParseResult<StatBlock>;
+export declare function parseKpiBlock(record: Record<string, unknown>, path: (string | number)[], base: BlockBase): ParseResult<KpiBlock>;
+export declare function parseChartBlock(record: Record<string, unknown>, path: (string | number)[], base: BlockBase): ParseResult<ChartBlock>;
+/** Dispatch for the four data block types; returns null when type is not data. */
+export declare function parseDataBlock(type: string, record: Record<string, unknown>, path: (string | number)[], base: BlockBase): ParseResult<DataBlock> | null;