@dcs-tech/ui 0.2.0 → 0.3.0

package/dist/types/shared-web-ui/src/DataTable/summary/summaryModel.d.ts

@@ -0,0 +1,152 @@
+import { type GroupLabels, type GroupValue } from '../grouping/groupModel';
+import { type DataTableColumn, type DataTableExportSummary, type DataTableFilterCondition, type DataTableFilterGroup, type DataTableSummaryAnyChart, type DataTableSummaryBreakdown, type DataTableSummaryBreakdownCard, type DataTableSummaryBucket, type DataTableSummaryCard, type DataTableSummaryFigure, type DataTableSummaryFunnelCard, type DataTableSummaryPart, type DataTableSummaryPeriod, type DataTableSummaryPeriodCount, type DataTableSummaryRequest, type DataTableSummaryShow, type DataTableSummarySubline, type DataTableSummaryTrendCard, type DataTableSummaryValueCard, type DataTableSummaryWidth } from '../types';
+import type { ChartSlot } from '../../Charts';
+export declare const SUMMARY_CONDITION_PREFIX = "summary:";
+export declare const summaryConditionId: (cardId: string) => string;
+export type SummaryChartCard = DataTableSummaryBreakdownCard | DataTableSummaryTrendCard | DataTableSummaryFunnelCard;
+export declare const isChartCard: (c: DataTableSummaryCard) => c is SummaryChartCard;
+export interface SummaryItem<T = any> {
+    key: string;
+    card: DataTableSummaryCard<T>;
+    width: DataTableSummaryWidth;
+}
+export declare function summaryChartsFor(card: DataTableSummaryCard): readonly DataTableSummaryAnyChart[];
+export declare function chartOf(card: DataTableSummaryCard): DataTableSummaryAnyChart;
+export declare function cardFigures<T>(card: DataTableSummaryCard<T>): DataTableSummaryFigure<T>[];
+export declare const SUMMARY_PART_TOP = 9;
+export declare function showPart(show: DataTableSummaryShow): DataTableSummaryPart;
+export declare function breakdownPart(card: DataTableSummaryBreakdownCard, partTop?: number): DataTableSummaryPart;
+export declare function partOf(buckets: readonly DataTableSummaryBucket[], part: DataTableSummaryPart): DataTableSummaryBreakdown;
+export declare const splits: (card: DataTableSummaryTrendCard) => boolean;
+export declare function summaryCardKey(card: SummaryChartCard | DataTableSummaryValueCard, partTop?: number): string;
+export declare function summaryRequest<T>(cards: DataTableSummaryCard<T>[], columns: DataTableColumn<T>[]): DataTableSummaryRequest;
+export declare function ownCondition(group: DataTableFilterGroup, cardId: string): DataTableFilterCondition | undefined;
+export declare function withoutOwnCondition(group: DataTableFilterGroup, cardId: string): DataTableFilterGroup;
+export declare function setSummaryCondition(group: DataTableFilterGroup, cardId: string, condition: DataTableFilterCondition | null): DataTableFilterGroup;
+export declare function breakdownCondition<T>(card: DataTableSummaryBreakdownCard, col: DataTableColumn<T> | undefined, value: GroupValue): DataTableFilterCondition;
+export declare function trendCondition(card: DataTableSummaryTrendCard, period: string): DataTableFilterCondition;
+export declare function funnelCondition(card: DataTableSummaryFunnelCard, stepId: string): DataTableFilterCondition | null;
+export declare const bucketKey: (v: GroupValue) => string;
+export declare const OTHERS_KEY = "\0others";
+export declare function selectedKey(card: SummaryChartCard, cond: DataTableFilterCondition | undefined): string | null;
+export declare function computeFigure<T>(figure: DataTableSummaryFigure<T>, rows: T[]): number;
+export declare function countValues<T>(rows: T[], col: DataTableColumn<T>): DataTableSummaryBucket[];
+export declare function withChildren<T>(answer: DataTableSummaryBreakdown, rows: T[], col: DataTableColumn<T>, within: DataTableColumn<T>): DataTableSummaryBreakdown;
+export declare const monthOf: (v: unknown) => string | null;
+export declare function lastMonths(n: number, now?: Date): string[];
+export declare function lastDays(n: number, now?: Date): string[];
+export declare function countPeriods<T>(rows: T[], col: DataTableColumn<T>, period: DataTableSummaryPeriod, count: number, now?: Date, split?: DataTableColumn<T>): DataTableSummaryPeriodCount[];
+export declare function figureSeries<T>(rows: T[], figure: DataTableSummaryFigure<T>, col: DataTableColumn<T>, period: DataTableSummaryPeriod, count: number, now?: Date): {
+    points: Array<{
+        period: string;
+        count: number;
+    }>;
+    previous: number;
+};
+export interface SummaryBucketView {
+    key: string;
+    value: GroupValue;
+    label: string;
+    count: number;
+    slot: ChartSlot;
+    others?: boolean;
+    children?: Array<{
+        key: string;
+        label: string;
+        count: number;
+    }>;
+}
+export declare function breakdownView<T>(card: DataTableSummaryBreakdownCard, col: DataTableColumn<T> | undefined, answer: DataTableSummaryBreakdown, labels: GroupLabels & {
+    others: string;
+}, partTop?: number, within?: DataTableColumn<T>): SummaryBucketView[];
+export declare const SUMMARY_BAR_ROWS = 6;
+export interface SummaryPeriodView {
+    key: string;
+    label: string;
+    fullLabel: string;
+    count: number;
+    split?: Record<string, number>;
+}
+export interface SummarySplitView {
+    key: string;
+    label: string;
+    slot: ChartSlot;
+}
+export declare function periodView(periods: ReadonlyArray<{
+    period: string;
+    count: number;
+}>, period: DataTableSummaryPeriod, locale?: string): SummaryPeriodView[];
+export declare function splitView<T>(card: DataTableSummaryTrendCard, periods: readonly DataTableSummaryPeriodCount[], col: DataTableColumn<T> | undefined, labels: GroupLabels): {
+    series: SummarySplitView[];
+    perPeriod: Array<Record<string, number>>;
+};
+export interface SummaryStepView {
+    key: string;
+    label: string;
+    count: number;
+    slot: ChartSlot;
+    selectable: boolean;
+}
+export type ResolvedSummaryCard<T = any> = {
+    key: string;
+    width: DataTableSummaryWidth;
+} & ({
+    kind: 'value';
+    card: DataTableSummaryCard<T> & {
+        kind: 'value';
+    };
+    value: number | null;
+    sub: {
+        line: DataTableSummarySubline<T>;
+        value: number | null;
+    } | null;
+    trend: {
+        points: SummaryPeriodView[];
+        previous: number;
+    } | null;
+} | {
+    kind: 'ratio';
+    card: DataTableSummaryCard<T> & {
+        kind: 'ratio';
+    };
+    value: number | null;
+    total: number | null;
+    sub: {
+        line: DataTableSummarySubline<T>;
+        value: number | null;
+    } | null;
+} | {
+    kind: 'breakdown';
+    card: DataTableSummaryBreakdownCard;
+    column: DataTableColumn<T> | undefined;
+    buckets: SummaryBucketView[] | null;
+    values: number;
+    selected: string | null;
+} | {
+    kind: 'trend';
+    card: DataTableSummaryTrendCard;
+    column: DataTableColumn<T> | undefined;
+    periods: SummaryPeriodView[] | null;
+    series: SummarySplitView[];
+    selected: string | null;
+} | {
+    kind: 'funnel';
+    card: DataTableSummaryFunnelCard<T>;
+    steps: SummaryStepView[] | null;
+    selected: string | null;
+} | {
+    kind: 'unavailable';
+    card: DataTableSummaryCard<T>;
+    reason: string;
+});
+export declare const drawsChart: (item: ResolvedSummaryCard) => boolean;
+export declare const shareOf: (value: number, total: number) => number;
+export declare function percentText(p: number): string;
+export declare function sublineText(line: DataTableSummarySubline, n: string): string;
+export declare function oneLine(cards: ResolvedSummaryCard[], num: (n: number) => string): string;
+export declare function summaryExport(cards: ResolvedSummaryCard[], L: {
+    summaryCount: string;
+    summaryMonth: string;
+    summaryDay: string;
+    summaryStep: string;
+}, num: (n: number) => string): DataTableExportSummary;

package/dist/types/shared-web-ui/src/DataTable/summary/summaryWidth.d.ts

@@ -0,0 +1,22 @@
+import type { DataTableColumn, DataTableSummaryCard, DataTableSummaryWidth } from '../types';
+export type SummaryFixedWidth = Exclude<DataTableSummaryWidth, 'auto'>;
+export declare const STRIP_FOUR_MIN = 1000;
+export declare function stripColumns(width: number): 1 | 2 | 4;
+export declare const WIDTH_ORDER: readonly SummaryFixedWidth[];
+export declare const spanOf: (width: SummaryFixedWidth, columns: number) => number;
+export declare function bestWidth(card: DataTableSummaryCard, values?: number): SummaryFixedWidth;
+export declare function knownValues(column: DataTableColumn | undefined): number | undefined;
+export declare const cardBestWidth: (card: DataTableSummaryCard, columns: readonly DataTableColumn[]) => SummaryFixedWidth;
+export declare function growTier(card: DataTableSummaryCard): 1 | 2 | 3 | 4;
+export interface StripCard {
+    key: string;
+    width: DataTableSummaryWidth;
+    best: SummaryFixedWidth;
+    tier: 1 | 2 | 3 | 4;
+}
+export interface StripCell {
+    key: string;
+    row: number;
+    span: number;
+}
+export declare function stripLayout(cards: readonly StripCard[], columns: number): StripCell[];

package/dist/types/shared-web-ui/src/DataTable/summary/useTableSummary.d.ts

@@ -0,0 +1,18 @@
+import type { DataTableColumn, DataTableFilterGroup, DataTableQuery, DataTableSummaryFigures } from '../types';
+import type { GroupLabels } from '../grouping/groupModel';
+import { type ResolvedSummaryCard, type SummaryItem } from './summaryModel';
+export interface TableSummaryInputs<TData> {
+    items: SummaryItem<TData>[];
+    columns: DataTableColumn<TData>[];
+    serverMode: boolean;
+    rowsFor: (cardId: string | null) => TData[];
+    figures: DataTableSummaryFigures | null;
+    filterGroup: DataTableFilterGroup;
+    query: DataTableQuery;
+    labels: GroupLabels & {
+        others: string;
+    };
+    locale?: string;
+}
+export declare function resolveSummaryCards<TData>({ items, columns, serverMode, rowsFor, figures, filterGroup, query, labels, locale }: TableSummaryInputs<TData>): ResolvedSummaryCard<TData>[];
+export declare function useTableSummary<TData>(inputs: TableSummaryInputs<TData>): ResolvedSummaryCard<TData>[];