@dcs-tech/ui 0.2.0 → 0.3.0

package/dist/types/shared-types/src/report/document.d.ts

@@ -1,93 +1,44 @@
-/**
- * Report engine — the two documents downstream of a template.
- *
- * A template is a design. Resolving it against data gives a **layout document**: every
- * placeholder substituted, every table expanded into its heading, rows, sections and closing rows,
- * every block reduced to rows of cells of already-wrapped lines, each carrying its measured height.
- * Paginating that gives a **paged document**: the same bands, dealt onto pages.
- *
- * The split is what lets a 2-inch till roll and an A4 invoice come out of one model. A continuous
- * roll stops at layout — it has no pages to assign anything to. See `docs/REPORT_ENGINE.md` §5.
- *
- * Renderers consume these, never the template. Nothing here mentions pdfmake, HTML or ESC/POS.
- */
 import type { BandKind } from './bands';
 import type { Alignment, PageConfig, StrokeStyle, TextStyle } from './primitives';
-/**
- * One wrapped line. It carries its own style because a template's segments are line-level in
- * practice — a bold label above a plain value — and flattening that to one style per cell would
- * lose it.
- */
 export interface LayoutLine {
     text: string;
     style?: TextStyle;
 }
-/** One cell, with its text already wrapped to `widthPt`. */
 export interface LayoutCell {
     widthPt: number;
     align?: Alignment;
-    /** The template column this cell prints for, so a designer can point at one column of a table. */
     columnId?: string;
     style?: TextStyle;
-    /** Wrapped lines. An empty array is an empty cell that still occupies its row. */
     lines: LayoutLine[];
-    /**
-     * Measured content height, padding excluded.
-     *
-     * Carried rather than recomputed from `lines`, because the line count is not always the whole
-     * story — shaped text that had to be force-broken costs more than its lines suggest, and a
-     * consumer counting lines would silently lose that.
-     */
     heightPt: number;
-    /** Drawn at the left of the cell; `heightPt` already covers it, the lines sit beside it. */
     image?: {
         src: string;
         widthPt: number;
         heightPt: number;
         gapPt: number;
     };
-    /** The row's bottom line is not drawn under this cell — a heading that spans two rows. */
     noBottomLine?: boolean;
 }
-/**
- * Lines drawn around one row, in points. `heightPt` of the row already includes `top` and
- * `bottom`, and the cells' widths already exclude `left`, `right` and `inner` — a renderer draws
- * these and adds nothing.
- */
 export interface RowBorder {
     top: number;
     bottom: number;
     left: number;
     right: number;
-    /** Between cells. */
     inner: number;
 }
 export interface LayoutRow {
     cells: LayoutCell[];
-    /** Includes `border.top` and `border.bottom`. */
     heightPt: number;
     border?: RowBorder;
-    /**
-     * Height added beyond the tallest cell to meet a row's minimum. Renderers that do not set a row
-     * height themselves (pdfmake) add it under the first cell, so the row comes out as planned.
-     */
     extraHeightPt?: number;
-    /** Drawn under this row. Renderers without rules ignore it. */
     separator?: StrokeStyle;
 }
-/**
- * What a block became.
- *
- * `rows` covers text blocks and table rows — everything textual collapses to the same shape, so a
- * renderer implements it once. The rest are leaves with a height and their own payload.
- */
 export type LayoutBlockKind = 'rows' | 'image' | 'barcode' | 'qr' | 'separator' | 'spacer';
 export interface LayoutBlock {
     id: string;
     kind: LayoutBlockKind;
     heightPt: number;
     style?: TextStyle;
-    /** [top, right, bottom, left], points. */
     marginPt?: [number, number, number, number];
     rows?: LayoutRow[];
     image?: {
@@ -115,51 +66,27 @@ export interface LayoutBlock {
         thicknessPt: number;
     };
 }
-/**
- * `space` is not something a template can declare: it is vertical space pagination puts between a
- * page's content and its footer, so the footer sits at the foot of the page. It has its own kind
- * so nothing mistakes it for the footer it pushes down.
- */
 export type LayoutBandKind = BandKind | 'space';
-/**
- * One appearance of something with a height, in print order. A content band becomes one of these
- * — or several, when a table inside it flows: the blocks before the table, then one band per table
- * row, then the blocks after.
- */
 export interface LayoutBand {
     id: string;
     kind: LayoutBandKind;
     heightPt: number;
     keepTogether?: boolean;
-    /** Must not end a page: moves on with the next band when that one does not fit here. */
     keepWithNext?: boolean;
-    /**
-     * Part of a flowing table: its rows, its section rows and its closing rows. Pagination repeats the
-     * table's heading above these, closes the box after the last of them on a page, and fills below.
-     */
     tableId?: string;
-    /** The table's heading, re-emitted on each page. */
     tableHeader?: boolean;
-    /** Rows that close the table. Pagination puts empty rows above these, not below. */
     tableFooter?: boolean;
-    /** The block the table came from, so a designer can map a click on any row back to it. */
     blockId?: string;
     blocks: LayoutBlock[];
 }
-/** What pagination needs to head, close and fill one flowing table. */
 export interface LayoutTable {
-    /** The template band the table sits in, for ids the engine mints later — the rows filling a page. */
     bandId: string;
-    /** The heading band, repeated on every page the table continues onto when `repeat` allows. */
     header?: LayoutBand;
     repeatHeader: boolean;
-    /** Box thickness; the last row of the table on a page is given at least this as its bottom line. */
     outerPt: number;
     fill: 'none' | 'lastPage' | 'everyPage';
-    /** One empty row, bordered like a table row — what a filled page is made of. */
     emptyRow: LayoutRow;
 }
-/** A watermark with its placeholders resolved and its condition already decided. */
 export interface LayoutWatermark {
     text?: string;
     image?: string;
@@ -173,23 +100,16 @@ export interface LayoutWatermark {
 export interface LayoutDocument {
     page: PageConfig;
     contentWidthPt: number;
-    /** Height available for flowing bands, page header and footer already deducted. */
     contentHeightPt: number;
-    /** Bands in print order, tables already expanded. */
     flow: LayoutBand[];
-    /** Repeated at the top of every page. */
     pageHeader: LayoutBand[];
-    /** Repeated at the bottom of every page. */
     pageFooter: LayoutBand[];
-    /** Flowing tables, by table id. */
     tables: Record<string, LayoutTable>;
     watermark?: LayoutWatermark;
 }
 export interface LayoutPage {
-    /** 1-based. */
     number: number;
     bands: LayoutBand[];
-    /** Height left unused after the last band — what filler rows would occupy. */
     freeHeightPt: number;
 }
 export interface PagedDocument {

package/dist/types/shared-types/src/report/primitives.d.ts

@@ -1,14 +1,5 @@
-/**
- * Report engine — leaf types.
- *
- * Deliberately compatible with the equivalents in the client's `LabelDesigner/types.ts`, which is
- * live and stays where it is. When that folder is eventually pointed at this package (see
- * `docs/REPORT_ENGINE.md` §2) the change should be an import swap, not a redesign — so keep these
- * shapes identical unless there is a reason not to.
- */
 import type { ReportConditionGroup } from './conditions';
 export type Alignment = 'left' | 'center' | 'right';
-/** Applied to the printed text before it is measured, so it wraps exactly as it prints. */
 export type TextCase = 'upper' | 'lower' | 'title';
 export interface TextStyle {
     fontFamily?: string;
@@ -18,7 +9,6 @@ export interface TextStyle {
     underline?: boolean;
     strike?: boolean;
     color?: string;
-    /** Cell/box background. Renderers without colour ignore it. */
     fill?: string;
     textCase?: TextCase;
 }
@@ -27,78 +17,48 @@ export type NumberFormatMode = 'none' | 'fixed' | 'round' | 'ceil' | 'floor';
 export interface NumberFormat {
     mode: NumberFormatMode;
     decimals: number;
-    /** Digit grouping. 'in' = 1,23,456.00 (lakh/crore); 'en' = 123,456.00; absent = none. */
     grouping?: 'in' | 'en';
-    /** A plus sign before a positive value — a round-off printed as "+0.24". */
     signed?: boolean;
 }
 export interface DateFormat {
-    /** Pattern, e.g. `dd-mm-yyyy` or `dd-mm-yyyy hh:mm`. */
     format: string;
-    /** Compute from today + offsetDays rather than reading the source value. */
     computed?: boolean;
     offsetDays?: number | string;
 }
-/**
- * How one placeholder renders. This is the whole of "date or date and time?", "two decimals or
- * three?", "show a dash when empty" — the questions that otherwise become format variants.
- */
 export interface PlaceholderFormat {
     type: 'text' | 'number' | 'date';
     numberFormat?: NumberFormat;
     dateFormat?: DateFormat;
     prefix?: string;
     suffix?: string;
-    /** Printed when the value is empty. Absent means print nothing. */
     defaultValue?: string;
 }
-/** Keyed by the placeholder token, e.g. `'%row.total%'`. */
 export type PlaceholderFormats = Record<string, PlaceholderFormat>;
-/**
- * A run of text. `content` may mix literals and `%source.key%` placeholders; the resolver
- * substitutes them and applies `formats`.
- */
 export interface TextSegment {
     id: string;
     content: string;
-    /** Inherit the enclosing block's style rather than carrying one. */
     useOwnStyle?: boolean;
     style?: TextStyle;
-    /** Break to a new line after this segment. */
     newLine?: boolean;
     formats?: PlaceholderFormats;
-    /** Printed only when this holds — a labelled line appears only when its value exists. */
     condition?: ReportConditionGroup;
 }
 export type PaperSize = 'A3' | 'A4' | 'A5' | 'A6' | 'Letter' | 'Legal' | 'Roll' | 'custom';
 export type PageOrientation = 'portrait' | 'landscape';
-/**
- * Drawn behind every page, centred. A page property rather than a band: it takes no room and
- * must never take part in pagination.
- */
 export interface Watermark {
-    /** Text, placeholders allowed. Ignored when `image` resolves to something. */
     text?: string;
-    /** A URL, a data URI, or a placeholder resolving to one. */
     image?: string;
-    /** Width of the image in points. Defaults to half the page width. */
     imageWidthPt?: number;
-    /** 0–1. Defaults to 0.15. */
     opacity?: number;
-    /** Degrees, text only. Defaults to -45. */
     angle?: number;
-    /** Text only. Defaults to 60. */
     fontSize?: number;
-    /** Text only. Defaults to a dark blue. */
     color?: string;
     bold?: boolean;
-    /** Drawn only when this holds — "only on a proforma", "only when the shop turned it on". */
     condition?: ReportConditionGroup;
 }
 export interface PageConfig {
     size: PaperSize;
     orientation: PageOrientation;
-    /** Required for 'custom'; for 'Roll', `heightMm` is 'auto' — a continuous, unpaged document. */
     widthMm?: number;
     heightMm?: number | 'auto';
     marginTopMm: number;

package/dist/types/shared-types/src/report/registry.d.ts

@@ -1,85 +1,39 @@
-/**
- * Report engine — the contract between the engine and whatever app is using it.
- *
- * THIS FILE IS WHY THE ENGINE IS GENERIC. The engine knows there are named scalar sources and
- * named row sets; it does not know that one of them is an invoice. Every domain word — invoice,
- * item, customer, size, colour — arrives at runtime through a `ReportRegistry` the app declares.
- *
- * If a domain term ever appears in `packages/shared-types/src/report/` or
- * `shared-logic/src/report/`, the abstraction has failed and the engine is an invoice renderer
- * with extra steps. See `docs/REPORT_ENGINE.md` §6 and §14.
- */
 import type { PlaceholderFormat } from './primitives';
 export type FieldType = 'text' | 'number' | 'date' | 'boolean' | 'image';
-/**
- * One addressable value. The engine uses `type` and `format` to render it and `label` to show it
- * in a picker; it never interprets `key`.
- */
 export interface FieldDef {
     key: string;
     label: string;
     type: FieldType;
-    /** Applied when a placeholder does not override it. */
     format?: PlaceholderFormat;
-    /** Whether `agg.*` may be taken over this field. Validation rejects aggregates over the rest. */
     aggregatable?: boolean;
-    /** Optional grouping for the field picker, e.g. 'Totals', 'Tax'. */
     group?: string;
 }
-/** A bag of scalars addressed as `%<key>.<field>%` — 'business', 'customer', 'summary'. */
 export interface SourceDef {
     key: string;
     label: string;
     fields: FieldDef[];
 }
-/**
- * How a row set serves as a LOOKUP — sizes, colours, dias — for a table that groups rows by an id.
- *
- * Only the app knows that `sizeid` "XL" sorts after "L"; it says so by passing the sizes as a row
- * set and naming which of its fields is the id, the name and the display order. The table then
- * points at it (`TableData.group.lookup`), and the designer offers it as a choice — which a
- * function in app code could never be.
- */
 export interface LookupDef {
-    /** Field holding the id rows are grouped by. */
     key: string;
-    /** Field printed as the value's name. */
     label: string;
-    /** Numeric field giving the display order. Absent: the order the rows arrive in. */
     order?: string;
 }
-/** An iterable set of rows addressed as `%row.<field>%` inside a table. */
 export interface RowSetDef {
     key: string;
     label: string;
     fields: FieldDef[];
-    /** Present when this row set can be used to name and order grouped values. */
     lookup?: LookupDef;
 }
-/**
- * Everything an app publishes about its data. Drives the field picker, validation, and resolution.
- * One registry per document kind ('invoice', 'stock-report', 'ageing', …).
- */
 export interface ReportRegistry {
     key: string;
     label: string;
     sources: SourceDef[];
     rowSets: RowSetDef[];
-    /**
-     * Named values computed in code and offered to templates as ordinary fields.
-     *
-     * This is the deliberate replacement for a formula language (`docs/REPORT_ENGINE.md` §7).
-     * Anything a template cannot express with placeholders, conditions and the fixed aggregate
-     * list becomes an entry here — reviewed, typed and testable — rather than a string a user
-     * typed into a box.
-     */
     computed?: FieldDef[];
 }
-/** The data itself, at render time. Shapes are opaque to the engine. */
 export interface ReportContext {
     sources: Record<string, Record<string, unknown>>;
     rowSets: Record<string, Array<Record<string, unknown>>>;
     computed?: Record<string, (ctx: ReportContext) => unknown>;
-    /** What the user picked for the template's print options, by option key. */
     options?: Record<string, unknown>;
 }

package/dist/types/shared-types/src/report/storage.d.ts

@@ -1,41 +1,10 @@
-/**
- * Report engine — how a template is stored.
- *
- * A shipped format is a SEED that lives in code. What a customer saves is a DIFF against that
- * seed, so a seed can be improved later without overwriting their work, and "this shop wants the
- * lorry number under the address" never becomes a file in the repository. See
- * `docs/REPORT_ENGINE.md` §8.
- *
- * NO RUNTIME VALUES IN THIS FOLDER — see the note at the top of `template.ts`. The doc name, the
- * diff and the resolver all live in `shared-logic/report/storage`.
- */
 import type { ReportTemplate } from './template';
-/**
- * One entry in the templates settings document. The map key is the template id, so `id` is never
- * stored inside the entry — it would be a second copy of the same fact, free to disagree.
- */
 export interface StoredReportTemplate {
-    /**
-     * Id of the shipped seed this diffs against. Absent means the customer authored the whole
-     * template, and `template` then holds all of it rather than a difference.
-     */
     seed?: string;
-    /**
-     * `REPORT_SCHEMA_VERSION` when the diff was written. The diff is migrated to the current
-     * version BEFORE it meets the seed — merging an old diff onto a new seed would produce a
-     * document that is half one shape and half the other.
-     */
     schemaVersion?: number;
-    /** false hides a format from the pickers without deleting the customer's edits. */
     active?: boolean;
-    /** Set by the app on write; the engine neither reads nor produces these. */
     createdts?: unknown;
     updatedts?: unknown;
-    /**
-     * The difference from the seed, by whole top-level key. A key absent here is taken from the
-     * seed, which is how a seed improvement reaches a customer who never touched that key.
-     */
     template?: Partial<ReportTemplate>;
 }
-/** The templates settings document: template id → entry. */
 export type ReportTemplatesStoredMap = Record<string, StoredReportTemplate>;

package/dist/types/shared-types/src/report/template.d.ts

@@ -1,92 +1,32 @@
-/**
- * Report engine — the authored document.
- *
- * A `ReportTemplate` is data. It is stored, diffed against a shipped seed, and edited by people
- * who are not developers, which is why `schemaVersion` is not optional and never will be: the day
- * a customer saves one of these, the shape is frozen for everybody and the only way forward is a
- * migration ladder. See `docs/REPORT_ENGINE.md` §8 and §14.
- */
-/**
- * NO RUNTIME VALUES IN THIS FOLDER.
- *
- * `REPORT_SCHEMA_VERSION` and `REPORT_AGGREGATES` were declared here and took the client's dev
- * server down. The client resolves `shared-types` to its CommonJS `dist/index.js`, and Vite finds
- * that file's named exports by static analysis which follows one hop of `__exportStar`. The
- * report model is a nested barrel — `index.js` → `report/index.js` → `template.js` — so a value
- * declared here is two hops away and simply is not found. Types are unaffected: they are erased
- * and never ask the loader for anything.
- *
- * Both constants now live in `shared-logic/report/constants`, which is where the client already
- * gets its runtime code.
- */
 import type { Band } from './bands';
 import type { PageConfig } from './primitives';
 export type TemplateOptionType = 'boolean' | 'select' | 'text' | 'number';
-/**
- * A choice made when printing — "Tax table by HSN or by rate", "Show the summary". The template
- * declares it, the app's print dialog shows it, and conditions and text read it as `%option.key%`.
- */
 export interface TemplateOption {
     key: string;
     label: string;
     type: TemplateOptionType;
-    /** For `select`. */
     choices?: Array<{
         value: string;
         label: string;
     }>;
-    /** Used when the app passes no value. */
     default?: string | number | boolean;
     description?: string;
 }
 export interface ReportTemplate {
-    /** `REPORT_SCHEMA_VERSION` at authoring time. Migrations run oldest → newest on read. */
     schemaVersion: number;
     id: string;
     name: string;
     description?: string;
-    /** Which `ReportRegistry` this template is written against. */
     registry: string;
     page: PageConfig;
     options?: TemplateOption[];
-    /** In print order. */
     bands: Band[];
 }
-/**
- * Line thicknesses for a table, in points. Absent or 0 draws nothing.
- *
- * Lines are GEOMETRY, not decoration: a 1pt line under a row makes that row 1pt taller, and a
- * vertical line makes the table 1pt wider. The engine budgets both, which is why this is four
- * numbers rather than a pdfmake `layout` callback — a callback can draw anything, and the planner
- * would have no way to know how tall it made the page.
- */
 export interface GridLines {
-    /** The box: above the heading, down both sides, and closing the table on every page. */
     outer?: number;
-    /** Between columns. */
     columns?: number;
-    /** Under the heading. */
     header?: number;
-    /** Between rows. */
     rows?: number;
 }
-/**
- * Empty rows added after a table's last row, so the box runs down to what follows.
- *
- * `lastPage` fills only the page the table ends on — the classic invoice, whose totals sit at the
- * foot of the page. `everyPage` also fills pages the table continues from, so a tall row that moved
- * to the next page does not leave a gap under the box.
- */
 export type GridFill = 'none' | 'lastPage' | 'everyPage';
-/**
- * The fixed aggregate set. There is no expression language and there will not be one; anything
- * beyond this becomes a field the app computes.
- *
- * Written `%agg.sum(row.total)%` inside a table's closing or section rows (that table's or section's
- * rows), `%agg.sum(group.qty)%` under a group column, or `%agg.sum(items.total)%` anywhere (a whole
- * row set as passed). `distinct` counts different values — `agg.distinct(items.sizeid)`.
- *
- * The matching runtime list lives in `shared-logic/report/constants` — see the note at the top of
- * this file for why it cannot live here.
- */
 export type ReportAggregate = 'sum' | 'count' | 'avg' | 'min' | 'max' | 'first' | 'last' | 'distinct';

package/dist/types/shared-types/src/ui/button.types.d.ts

@@ -2,11 +2,8 @@ import type { DataAttributes } from './common.types';
 import type { ControlSize, SemanticColor } from './control.types';
 import type { TooltipProp, TooltipTrigger } from './tooltip.types';
 import { CSSProperties, ReactNode, MouseEvent, PointerEvent, KeyboardEvent, FocusEvent, ElementType, Ref } from 'react';
-/** Button's own surface treatments — unrelated to the field variants. */
 export type ButtonVariant = 'filled' | 'outlined' | 'text' | 'elevated' | 'tonal';
-/** @see ControlSize — a Button sizes on the same scale as the fields beside it. */
 export type ButtonSize = ControlSize;
-/** Buttons take the full semantic axis, `neutral` included. */
 export type ButtonColor = SemanticColor;
 export type ButtonShape = 'rectangle' | 'rounded' | 'pill' | 'circle' | 'square';
 export type LoadingPosition = 'start' | 'end' | 'center' | 'overlay';
@@ -26,8 +23,6 @@ export interface ButtonProps extends DataAttributes {
     onBlur?: (event: FocusEvent<HTMLElement>) => void;
     onMouseEnter?: (event: MouseEvent<HTMLElement>) => void;
     onMouseLeave?: (event: MouseEvent<HTMLElement>) => void;
-    /** Button has no rest-prop spread, so hover-driven wrappers (Tooltip clones
-        its child) need these declared or they are silently dropped. */
     onPointerEnter?: (event: PointerEvent<HTMLElement>) => void;
     onPointerMove?: (event: PointerEvent<HTMLElement>) => void;
     onPointerLeave?: (event: PointerEvent<HTMLElement>) => void;
@@ -37,13 +32,7 @@ export interface ButtonProps extends DataAttributes {
     startIcon?: ReactNode;
     endIcon?: ReactNode;
     icon?: ReactNode;
-    /** Same contract as every field's `tooltip`: bare content, or a config
-        object when placement/delay matter. Button already routed this through
-        `useTooltip`/`normalizeTooltip` at runtime — the type said `string`. */
     tooltip?: TooltipProp;
-    /** Accepted for uniformity with the fields. A Button is its own trigger, so
-        `icon` and `control` behave alike; the prop exists so a field and a
-        button can be spread from the same props object. */
     tooltipTrigger?: TooltipTrigger;
     disabled?: boolean;
     loading?: boolean;

package/dist/types/shared-types/src/ui/checkbox.types.d.ts

@@ -20,10 +20,6 @@ export interface CheckboxProps extends ToggleFieldProps<string | number, HTMLInp
     checked?: boolean;
     indeterminate?: boolean;
     defaultChecked?: boolean;
-    /**
-     * @deprecated Use `hint` — the shared name for this slot, which is what
-     * FieldWrapper renders. Kept until the components migrate (step 0c).
-     */
     helperText?: string | ReactNode;
     checkboxClassName?: string;
     checkedIcon?: ReactNode;

package/dist/types/shared-types/src/ui/chipinput.types.d.ts

@@ -1,11 +1,6 @@
 import type { Ref } from 'react';
 import type { FieldSize, FieldVariant, FieldLayout } from './fieldWrapper.types';
 import type { TextFieldProps } from './field.types';
-/**
- * How a token is spelled. `braces` — `{invoice.number}` — is what ChipInput has always used.
- * `percent` — `%invoice.number%` — is the report engine's spelling, and it allows keys a brace token
- * cannot hold, such as `agg.sum(row.total)`.
- */
 export type ChipTokenSyntax = 'braces' | 'percent';
 export interface ChipKey {
     key: string;
@@ -37,7 +32,6 @@ export interface ParsedSegment {
 }
 export interface ResolveOptions {
     fallback?: string;
-    /** Default `braces`. */
     syntax?: ChipTokenSyntax;
     undefinedBehavior?: 'keep' | 'remove' | 'fallback';
 }
@@ -52,12 +46,9 @@ export interface FormatValidationResult {
 }
 export type ChipInputSize = FieldSize;
 export type ChipInputVariant = FieldVariant;
-/** Was `'vertical' | 'horizontal' | 'inline'` — the same three arrangements
-    every other field calls `'default' | 'horizontal' | 'inline'`. */
 export type ChipInputLayout = FieldLayout;
 export interface ChipInputProps extends TextFieldProps<string, HTMLDivElement> {
     sources: ChipSources;
-    /** How tokens are spelled in `value`. Default `braces`. */
     syntax?: ChipTokenSyntax;
     inputClassName?: string;
     previewData?: Record<string, Record<string, any>>;
@@ -67,7 +58,6 @@ export interface ChipInputProps extends TextFieldProps<string, HTMLDivElement> {
 export interface UseChipSuggestionsOptions {
     sources: ChipSources;
     searchTerm: string;
-    /** Spelling of the tokens suggestions insert. Default `braces`. */
     syntax?: ChipTokenSyntax;
 }
 export interface UseChipSuggestionsReturn {

package/dist/types/shared-types/src/ui/collapsible.types.d.ts

@@ -3,20 +3,11 @@ import type { TooltipProp } from './tooltip.types';
 import type { ControlSize, SemanticColor } from './control.types';
 export type CollapsibleVariant = 'default' | 'bordered' | 'separated' | 'filled' | 'minimal';
 export type CollapsibleSize = ControlSize;
-/** A container tints from the surface end of the axis, not the state end —
-    a "warning" accordion is a badge's job, not the panel's. */
 export type CollapsibleColor = Extract<SemanticColor, 'primary' | 'secondary' | 'neutral'>;
 export type CollapsibleIconPosition = 'start' | 'end';
 export type CollapsibleExpansionMode = 'single' | 'multiple';
-/** How the open/closed state is signalled: a rotating chevron, or + → −. */
 export type CollapsibleDisclosure = 'chevron' | 'plusminus';
-/** Tint applied to an item's leading icon (and its tile, when tiles are on). */
 export type CollapsibleTone = 'primary' | 'secondary' | 'success' | 'warning' | 'error' | 'info' | 'neutral';
-/**
- * Heading level the trigger is wrapped in. The accordion pattern requires the
- * button to sit inside a heading so the panels appear in the document outline —
- * the right level depends on the surrounding page, so it is a prop.
- */
 export type CollapsibleHeadingLevel = 2 | 3 | 4 | 5 | 6;
 export interface CollapsibleAuthorize {
     type: 'r' | 's' | 'b';
@@ -31,13 +22,9 @@ export interface CollapsibleAuthorize {
 export interface CollapsibleItemProps {
     id?: string;
     title: string | ReactNode;
-    /** Leading icon, shown before the title — not the open/close chevron. */
     icon?: ReactNode;
-    /** Tint for that leading icon and its tile. */
     iconTone?: CollapsibleTone;
-    /** Trailing summary on the header row: "12 items", "₹1,25,000". */
     meta?: string | ReactNode;
-    /** Shown on hover/focus of the header trigger. */
     tooltip?: TooltipProp;
     children?: ReactNode;
     Component?: ComponentType<any>;
@@ -70,11 +57,8 @@ export interface CollapsibleProps {
     size?: CollapsibleSize;
     color?: CollapsibleColor;
     iconPosition?: CollapsibleIconPosition;
-    /** Chevron (default) or +/− for the open/close affordance. */
     disclosure?: CollapsibleDisclosure;
-    /** Leading icons sit in a tinted rounded tile. Off = bare glyph. */
     iconTile?: boolean;
-    /** Heading level wrapping each trigger. Default 3. */
     headingLevel?: CollapsibleHeadingLevel;
     disabled?: boolean;
     className?: string;
@@ -82,11 +66,9 @@ export interface CollapsibleProps {
     animated?: boolean;
     animationDuration?: number;
     showDividers?: boolean;
-    /** Expanded headers stick to the top of the scroll container. */
     stickyHeaders?: boolean;
     collapsedIcon?: ReactNode;
     expandedIcon?: ReactNode;
-    /** Arrow/Home/End move focus between headers, per the accordion pattern. */
     keyboardNavigation?: boolean;
     'aria-label'?: string;
     'aria-labelledby'?: string;

package/dist/types/shared-types/src/ui/common.types.d.ts

@@ -1,14 +1,3 @@
-/**
- * Shared contract every web component in @pdfinvoice/shared-web-ui satisfies.
- *
- * Each component enumerates the props it understands. Without this, anything not
- * on that allow-list is silently dropped — including `data-*` attributes, which
- * test harnesses (Storybook/Testing Library) and the editable-table cell
- * addressing both rely on.
- *
- * A `data-${string}` template index signature is used rather than
- * `[key: string]: any` so arbitrary misspelled props are still rejected.
- */
 export interface DataAttributes {
     [dataAttr: `data-${string}`]: unknown;
 }