@xnetjs/data 0.3.0 → 0.5.0

package/dist/view-types-DSde-uT_.d.ts

@@ -1,316 +0,0 @@
-/**
- * Column type definitions for database columns.
- *
- * Columns are stored in the database's Y.Doc as a Y.Array of Y.Maps,
- * enabling CRDT-based ordering and real-time schema sync.
- */
-/**
- * All supported column types.
- */
-type ColumnType = 'text' | 'number' | 'checkbox' | 'date' | 'dateRange' | 'select' | 'multiSelect' | 'person' | 'url' | 'email' | 'phone' | 'file' | 'relation' | 'tasks' | 'rollup' | 'formula' | 'richText' | 'created' | 'createdBy' | 'updated' | 'updatedBy';
-/**
- * Column definition stored in the database's Y.Doc.
- */
-interface ColumnDefinition {
-    /** Unique column ID (nanoid) */
-    id: string;
-    /** Display name */
-    name: string;
-    /** Column type */
-    type: ColumnType;
-    /** Type-specific configuration */
-    config: ColumnConfig;
-    /** Width in pixels (for table view) */
-    width?: number;
-    /** Whether this is the title column */
-    isTitle?: boolean;
-}
-/**
- * Union of all column configuration types.
- */
-type ColumnConfig = TextColumnConfig | NumberColumnConfig | SelectColumnConfig | RelationColumnConfig | RollupColumnConfig | FormulaColumnConfig | DateColumnConfig | FileColumnConfig | EmptyConfig;
-/**
- * Empty config for simple types with no configuration.
- */
-type EmptyConfig = Record<string, never>;
-/**
- * Text column configuration.
- */
-interface TextColumnConfig {
-    /** Maximum length (optional) */
-    maxLength?: number;
-}
-/**
- * Number column configuration.
- */
-interface NumberColumnConfig {
-    /** Number format */
-    format?: 'number' | 'percent' | 'currency';
-    /** Currency code (if format is currency) */
-    currency?: string;
-    /** Decimal places */
-    precision?: number;
-}
-/**
- * Select/MultiSelect column configuration.
- */
-interface SelectColumnConfig {
-    /** Available options */
-    options: SelectOption[];
-    /** Allow creating new options inline */
-    allowCreate?: boolean;
-}
-/**
- * A single select option.
- */
-interface SelectOption {
-    id: string;
-    name: string;
-    color?: SelectColor;
-}
-/**
- * Available colors for select options.
- */
-type SelectColor = 'gray' | 'brown' | 'orange' | 'yellow' | 'green' | 'blue' | 'purple' | 'pink' | 'red';
-/**
- * Relation column configuration.
- */
-interface RelationColumnConfig {
-    /** Target database ID */
-    targetDatabase: string;
-    /** Allow multiple relations */
-    allowMultiple?: boolean;
-}
-/**
- * Rollup column configuration.
- */
-interface RollupColumnConfig {
-    /** Column ID of the relation to aggregate */
-    relationColumn: string;
-    /** Column ID on related rows to aggregate */
-    targetColumn: string;
-    /** Aggregation function */
-    aggregation: RollupAggregation;
-}
-/**
- * Available rollup aggregation functions.
- */
-type RollupAggregation = 'sum' | 'avg' | 'count' | 'min' | 'max' | 'concat' | 'unique' | 'empty' | 'notEmpty' | 'percentEmpty' | 'percentNotEmpty';
-/**
- * Formula column configuration.
- */
-interface FormulaColumnConfig {
-    /** Formula expression with {{columnId}} references */
-    expression: string;
-    /** Result type */
-    resultType: 'text' | 'number' | 'date' | 'checkbox';
-    /** Cached dependencies (auto-computed from expression) */
-    dependencies?: string[];
-}
-/**
- * Date column configuration.
- */
-interface DateColumnConfig {
-    /** Include time */
-    includeTime?: boolean;
-    /** Date format */
-    format?: 'full' | 'short' | 'relative';
-}
-/**
- * File column configuration.
- */
-interface FileColumnConfig {
-    /** Accepted MIME types */
-    accept?: string[];
-    /** Allow multiple files */
-    allowMultiple?: boolean;
-}
-/**
- * Check if a column type stores data in NodeStore (vs Y.Doc).
- */
-declare function isNodeStoreColumnType(type: ColumnType): boolean;
-/**
- * Check if a column type is computed (formula/rollup).
- */
-declare function isComputedColumnType(type: ColumnType): boolean;
-/**
- * Check if a column type is auto-populated.
- */
-declare function isAutoColumnType(type: ColumnType): boolean;
-/**
- * Check if a column type uses Y.Doc for storage.
- */
-declare function isYDocColumnType(type: ColumnType): boolean;
-
-/**
- * Summary engine for the database grid's footer bar (Airtable parity).
- *
- * Pure, store-agnostic per-column aggregations: given the rows currently in
- * view, a column, and a chosen {@link SummaryFunction}, compute one footer
- * value. Type-aware — `SUMMARY_FUNCTIONS_BY_TYPE` lists which functions a
- * given column type may offer. Numbers add sum/average/min/max/range/median;
- * checkboxes add checked/unchecked; dates add earliest/latest; every type
- * offers the count family (filled/empty/unique and their percentages).
- *
- * Kept deliberately free of React/Y.Doc/NodeStore so it is trivially unit
- * tested and shared by `GridSummaryBar` and any future query-result footer.
- */
-
-/** A row reduced to the cells the summary bar reads. */
-interface SummaryRow {
-    cells: Record<string, unknown>;
-}
-/** The minimum a summary needs to know about a column. */
-interface SummaryColumnLike {
-    id: string;
-    type: ColumnType;
-}
-/** A footer aggregation. `none` renders nothing. */
-type SummaryFunction = 'none' | 'filled' | 'empty' | 'percentFilled' | 'percentEmpty' | 'unique' | 'sum' | 'average' | 'min' | 'max' | 'range' | 'median' | 'checked' | 'unchecked' | 'percentChecked' | 'percentUnchecked' | 'earliest' | 'latest';
-/** The result of computing one column summary. */
-interface ColumnSummaryResult {
-    fn: SummaryFunction;
-    /** Numeric value where meaningful (percentages are 0–100); else null. */
-    value: number | null;
-    /** Formatted display string (`''` for `none`, `'—'` for empty/N-A). */
-    display: string;
-}
-/** Which summary functions each column type offers, in menu order. */
-declare const SUMMARY_FUNCTIONS_BY_TYPE: Record<ColumnType, SummaryFunction[]>;
-/** Human label for a summary function (for menus and footer captions). */
-declare function summaryFunctionLabel(fn: SummaryFunction): string;
-/** A cell counts as filled unless it is null/undefined, '', or an empty array. */
-declare function isFilledValue(value: unknown): boolean;
-/**
- * Compute a single column summary over the in-view rows.
- *
- * @param rows - rows currently displayed (already filtered)
- * @param column - the column being summarised
- * @param fn - the chosen aggregation
- */
-declare function computeColumnSummary(rows: readonly SummaryRow[], column: SummaryColumnLike, fn: SummaryFunction): ColumnSummaryResult;
-
-/**
- * Row-height density tiers for the database grid (Airtable parity).
- *
- * A view persists a named tier; the grid resolves it to a pixel height that
- * `GridSurface` uses for virtualization and row layout. Pure + tiny so the
- * toolbar control, the schema default, and the grid all agree on one mapping.
- */
-/** Named row-height tiers, densest first. */
-type RowHeight = 'short' | 'medium' | 'tall' | 'extraTall';
-/** Pixel height per tier (approximating Airtable's Short/Medium/Tall/Extra). */
-declare const ROW_HEIGHT_PX: Record<RowHeight, number>;
-/** Tier order for cycling / menu rendering. */
-declare const ROW_HEIGHTS: RowHeight[];
-/** Human label for a tier. */
-declare function rowHeightLabel(height: RowHeight): string;
-/** The default tier (densest, matching the prior fixed look). */
-declare const DEFAULT_ROW_HEIGHT: RowHeight;
-/**
- * Resolve a persisted value (possibly undefined or an unknown string) to a
- * pixel height, falling back to the default tier.
- */
-declare function resolveRowHeightPx(height: string | null | undefined): number;
-/** Narrow an arbitrary string to a `RowHeight`, or the default. */
-declare function asRowHeight(height: string | null | undefined): RowHeight;
-
-/**
- * View type definitions for database views.
- *
- * Views are stored in the database's Y.Doc as a Y.Map of view configs,
- * enabling collaborative view editing and real-time sync.
- */
-
-/**
- * Available view types.
- */
-type ViewType = 'table' | 'board' | 'list' | 'gallery' | 'calendar' | 'timeline';
-/**
- * View configuration stored in the database's Y.Doc.
- */
-interface ViewConfig {
-    /** Unique view ID */
-    id: string;
-    /** Display name */
-    name: string;
-    /** View type */
-    type: ViewType;
-    /** Column visibility and order */
-    visibleColumns: string[];
-    /** Per-column widths (overrides column.width) */
-    columnWidths?: Record<string, number>;
-    /** Filter configuration */
-    filters?: FilterGroup | null;
-    /** Sort configuration */
-    sorts?: SortConfig[];
-    /** Group by column ID */
-    groupBy?: string | null;
-    /** Group sort direction */
-    groupSort?: 'asc' | 'desc';
-    /** Collapsed group IDs */
-    collapsedGroups?: string[];
-    /** Row-height density tier */
-    rowHeight?: RowHeight;
-    /** Per-column footer summary functions: columnId -> SummaryFunction */
-    columnSummaries?: Record<string, SummaryFunction>;
-    /** Cover image column ID */
-    coverColumn?: string;
-    /** Card size */
-    cardSize?: 'small' | 'medium' | 'large';
-    /** Start date column ID */
-    dateColumn?: string;
-    /** End date column ID */
-    endDateColumn?: string;
-}
-/**
- * A group of filter conditions combined with AND/OR.
- */
-interface FilterGroup {
-    /** Logical operator */
-    operator: 'and' | 'or';
-    /** Conditions or nested groups */
-    conditions: Array<FilterCondition | FilterGroup>;
-}
-/**
- * A single filter condition.
- */
-interface FilterCondition {
-    /** Column ID to filter on */
-    columnId: string;
-    /** Filter operator */
-    operator: FilterOperator;
-    /** Filter value (type depends on column type and operator) */
-    value: unknown;
-}
-/**
- * Available filter operators.
- */
-type FilterOperator = 'equals' | 'notEquals' | 'contains' | 'notContains' | 'startsWith' | 'endsWith' | 'isEmpty' | 'isNotEmpty' | 'greaterThan' | 'lessThan' | 'greaterOrEqual' | 'lessOrEqual' | 'before' | 'after' | 'between' | 'hasAny' | 'hasAll' | 'hasNone';
-/**
- * Sort configuration for a column.
- */
-interface SortConfig {
-    /** Column ID to sort by */
-    columnId: string;
-    /** Sort direction */
-    direction: 'asc' | 'desc';
-}
-/**
- * Check if a filter item is a group (vs a condition).
- */
-declare function isFilterGroup(item: FilterCondition | FilterGroup): item is FilterGroup;
-/**
- * Check if a filter item is a condition (vs a group).
- */
-declare function isFilterCondition(item: FilterCondition | FilterGroup): item is FilterCondition;
-/**
- * Check if a view type supports grouping.
- */
-declare function supportsGrouping(type: ViewType): boolean;
-/**
- * Check if a view type requires a date column.
- */
-declare function requiresDateColumn(type: ViewType): boolean;
-
-export { type SummaryColumnLike as A, type ColumnSummaryResult as B, type ColumnType as C, type DateColumnConfig as D, type EmptyConfig as E, type FormulaColumnConfig as F, ROW_HEIGHT_PX as G, ROW_HEIGHTS as H, DEFAULT_ROW_HEIGHT as I, rowHeightLabel as J, resolveRowHeightPx as K, asRowHeight as L, type RowHeight as M, type NumberColumnConfig as N, type RelationColumnConfig as R, type SelectColumnConfig as S, type TextColumnConfig as T, type ViewType as V, type RollupColumnConfig as a, type FileColumnConfig as b, type ColumnDefinition as c, type ColumnConfig as d, type SelectOption as e, type SelectColor as f, type RollupAggregation as g, isComputedColumnType as h, isNodeStoreColumnType as i, isAutoColumnType as j, isYDocColumnType as k, type ViewConfig as l, type FilterGroup as m, type FilterCondition as n, type FilterOperator as o, type SortConfig as p, isFilterGroup as q, isFilterCondition as r, supportsGrouping as s, requiresDateColumn as t, SUMMARY_FUNCTIONS_BY_TYPE as u, summaryFunctionLabel as v, isFilledValue as w, computeColumnSummary as x, type SummaryFunction as y, type SummaryRow as z };