@hisptz/dhis2-analytics 1.0.10 → 1.0.11

package/build/types/components/PivotTable/components/PivotTableContainer.d.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+export interface PivotTableContainerProps {
+    children: React.ReactNode;
+    height: number;
+    width: number;
+    tableProps?: Record<string, any>;
+}
+export declare const PivotTableContainer: React.ForwardRefExoticComponent<PivotTableContainerProps & React.RefAttributes<HTMLDivElement>>;

package/build/types/components/PivotTable/components/PivotTableDimensionLabelCell.d.ts

@@ -0,0 +1,13 @@
+/// <reference types="react" />
+import PropTypes from 'prop-types';
+export interface PivotTableDimensionLabelCellProps {
+    rowLevel: number;
+    columnLevel: number;
+}
+export declare const PivotTableDimensionLabelCell: {
+    ({ rowLevel, columnLevel }: PivotTableDimensionLabelCellProps): JSX.Element | null;
+    propTypes: {
+        columnLevel: PropTypes.Validator<number>;
+        rowLevel: PropTypes.Validator<number>;
+    };
+};

package/build/types/components/PivotTable/components/PivotTableEmptyCell.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+export interface PivotTableEmptyCellProps {
+    classes?: any[] | string;
+    onClick?: () => void;
+    [key: string]: any;
+}
+export declare const PivotTableEmptyCell: React.ForwardRefExoticComponent<Pick<PivotTableEmptyCellProps, keyof PivotTableEmptyCellProps> & React.RefAttributes<HTMLTableCellElement | null>>;

package/build/types/components/PivotTable/components/PivotTableEmptyRow.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="react" />
+export declare const PivotTableEmptyRow: ({ height, columns }: {
+    height: number;
+    columns: any[];
+}) => JSX.Element | null;

package/build/types/components/PivotTable/components/PivotTableEngineContext.d.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+import { PivotTableEngine } from "../services/engine";
+export declare const PivotTableEngineContext: React.Context<PivotTableEngine | null>;
+export declare const Provider: ({ engine, children }: {
+    engine: PivotTableEngine;
+    children: React.ReactNode;
+}) => JSX.Element;
+export declare const usePivotTableEngine: () => PivotTableEngine | null;

package/build/types/components/PivotTable/components/PivotTableHead.d.ts

@@ -0,0 +1,21 @@
+/// <reference types="react" />
+import PropTypes from 'prop-types';
+import { ClippingResult } from "../interfaces";
+export interface PivotTableHeadProps {
+    clippingResult: ClippingResult;
+    width: number;
+    sortBy: {
+        order: number;
+        column: number;
+    } | null;
+    onSortByColumn: (column: number) => void;
+}
+export declare const PivotTableHead: {
+    ({ clippingResult, width, sortBy, onSortByColumn, }: PivotTableHeadProps): JSX.Element;
+    propTypes: {
+        clippingResult: PropTypes.Validator<object>;
+        width: PropTypes.Validator<number>;
+        onSortByColumn: PropTypes.Validator<(...args: any[]) => any>;
+        sortBy: PropTypes.Requireable<object>;
+    };
+};

package/build/types/components/PivotTable/components/PivotTableHeaderCell.d.ts

@@ -0,0 +1,22 @@
+import PropTypes from 'prop-types';
+import { AxisClippingResult } from "../interfaces";
+import React from "react";
+export interface PivotTableHeaderCellProps {
+    axisClippingResult: AxisClippingResult;
+    index: number;
+    level: number;
+    getHeader: (id: string) => Record<string, any>;
+    render: (element: Record<string, any>) => React.ReactElement;
+    showHierarchy?: boolean;
+}
+export declare const PivotTableHeaderCell: {
+    ({ axisClippingResult, index, level, getHeader, render, showHierarchy, }: PivotTableHeaderCellProps): React.ReactElement<any, string | React.JSXElementConstructor<any>> | null;
+    propTypes: {
+        axisClippingResult: PropTypes.Validator<object>;
+        getHeader: PropTypes.Validator<(...args: any[]) => any>;
+        index: PropTypes.Validator<number>;
+        level: PropTypes.Validator<number>;
+        render: PropTypes.Validator<(...args: any[]) => any>;
+        showHierarchy: PropTypes.Validator<boolean>;
+    };
+};

package/build/types/components/PivotTable/components/PivotTableRow.d.ts

@@ -0,0 +1,19 @@
+/// <reference types="react" />
+import PropTypes from 'prop-types';
+import { ClippingResult, ToggleContextualMenuFunction } from "../interfaces";
+export interface PivotTableRowProps {
+    clippingResult: ClippingResult;
+    rowIndex: number;
+    onToggleContextualMenu?: ToggleContextualMenuFunction;
+}
+export declare const PivotTableRow: {
+    ({ clippingResult, rowIndex, onToggleContextualMenu, }: PivotTableRowProps): JSX.Element | null;
+    propTypes: {
+        clippingResult: PropTypes.Validator<NonNullable<PropTypes.InferProps<{
+            columns: PropTypes.Validator<object>;
+            rows: PropTypes.Validator<object>;
+        }>>>;
+        rowIndex: PropTypes.Validator<number>;
+        onToggleContextualMenu: PropTypes.Requireable<(...args: any[]) => any>;
+    };
+};

package/build/types/components/PivotTable/components/PivotTableRowHeaderCell.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="react" />
+import { ClippingResult } from "../interfaces";
+export interface PivotTableRowHeaderCellProps {
+    clippingResult: ClippingResult;
+    rowIndex: number;
+    rowLevel: number;
+}
+export declare const PivotTableRowHeaderCell: ({ clippingResult, rowIndex, rowLevel, }: PivotTableRowHeaderCellProps) => JSX.Element | null;

package/build/types/components/PivotTable/components/PivotTableTitleRow.d.ts

@@ -0,0 +1,21 @@
+/// <reference types="react" />
+import PropTypes from 'prop-types';
+export interface PivotTableTitleRowProps {
+    containerWidth: number;
+    scrollPosition: {
+        x: number;
+    };
+    title: string;
+    totalWidth: number;
+}
+export declare const PivotTableTitleRow: {
+    ({ title, scrollPosition, containerWidth, totalWidth, }: PivotTableTitleRowProps): JSX.Element | null;
+    propTypes: {
+        containerWidth: PropTypes.Validator<number>;
+        scrollPosition: PropTypes.Validator<NonNullable<PropTypes.InferProps<{
+            x: PropTypes.Validator<number>;
+        }>>>;
+        title: PropTypes.Validator<string>;
+        totalWidth: PropTypes.Validator<number>;
+    };
+};

package/build/types/components/PivotTable/components/PivotTableTitleRows.d.ts

@@ -0,0 +1,12 @@
+/// <reference types="react" />
+import PropTypes from 'prop-types';
+export declare const PivotTableTitleRows: {
+    ({ clippingResult, width }: {
+        clippingResult: Record<string, any>;
+        width: number;
+    }): JSX.Element | null;
+    propTypes: {
+        clippingResult: PropTypes.Validator<object>;
+        width: PropTypes.Validator<number>;
+    };
+};

package/build/types/components/PivotTable/components/PivotTableValueCell.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="react" />
+import { ToggleContextualMenuFunction } from "../interfaces";
+export interface PivotTableValueCellProps {
+    row: number;
+    column: number;
+    onToggleContextualMenu?: ToggleContextualMenuFunction;
+}
+export declare const PivotTableValueCell: ({ row, column, onToggleContextualMenu, }: PivotTableValueCellProps) => JSX.Element | null;

package/build/types/components/PivotTable/constants/dataTypes.d.ts

@@ -0,0 +1,90 @@
+export type DataDimensionType = 'INDICATOR' | 'DATA_ELEMENT' | 'DATA_SET' | 'EVENT_DATA_ITEM' | 'PROGRAM_INDICATOR';
+export declare const DIMENSION_TYPE_ALL = "ALL";
+export declare const DIMENSION_TYPE_INDICATOR = "INDICATOR";
+export declare const DIMENSION_TYPE_DATA_ELEMENT = "DATA_ELEMENT";
+export declare const DIMENSION_TYPE_DATA_SET = "DATA_SET";
+export declare const DIMENSION_TYPE_EVENT_DATA_ITEM = "EVENT_DATA_ITEM";
+export declare const DIMENSION_TYPE_PROGRAM_INDICATOR = "PROGRAM_INDICATOR";
+export declare const DIMENSION_TYPE_PROGRAM_DATA_ELEMENT = "PROGRAM_DATA_ELEMENT";
+export declare const DIMENSION_TYPE_PROGRAM_ATTRIBUTE = "PROGRAM_ATTRIBUTE";
+export declare const DIMENSION_TYPE_DATA_ELEMENT_OPERAND = "DATA_ELEMENT_OPERAND";
+export declare const DIMENSION_TYPE_CATEGORY = "CATEGORY";
+export declare const DIMENSION_TYPE_CATEGORY_OPTION_GROUP_SET = "CATEGORY_OPTION_GROUP_SET";
+export declare const DIMENSION_TYPE_DATA_ELEMENT_GROUP_SET = "DATA_ELEMENT_GROUP_SET";
+export declare const DIMENSION_TYPE_DATA = "DATA_X";
+export declare const DIMENSION_TYPE_PERIOD = "PERIOD";
+export declare const DIMENSION_TYPE_ORGANISATION_UNIT = "ORGANISATION_UNIT";
+export declare const DIMENSION_TYPE_ORGANISATION_UNIT_GROUP_SET = "ORGANISATION_UNIT_GROUP_SET";
+export declare const TOTALS = "totals";
+export declare const DETAIL = "detail";
+export declare const SUB_GROUP_DETAIL = "DETAIL";
+export declare const SUB_GROUP_METRIC = "METRIC";
+export declare const dataTypeMap: {
+    INDICATOR: {
+        id: string;
+        getName: () => any;
+        getGroupLabel: () => any;
+        defaultGroup: {
+            id: string;
+            getName: () => any;
+        };
+        getItemName: () => any;
+        getGroupEmptyLabel: () => any;
+        getGroupLoadingLabel: () => any;
+    };
+    DATA_ELEMENT: {
+        id: string;
+        getName: () => any;
+        getGroupLabel: () => any;
+        defaultGroup: {
+            id: string;
+            getName: () => any;
+        };
+        subGroup: string;
+        getItemName: () => any;
+        getGroupEmptyLabel: () => any;
+        getGroupLoadingLabel: () => any;
+    };
+    DATA_SET: {
+        id: string;
+        getName: () => any;
+        getGroupLabel: () => any;
+        defaultGroup: {
+            id: string;
+            getName: () => any;
+        };
+        subGroup: string;
+        getItemName: () => any;
+        getGroupEmptyLabel: () => any;
+        getGroupLoadingLabel: () => any;
+    };
+    EVENT_DATA_ITEM: {
+        id: string;
+        getName: () => any;
+        getGroupLabel: () => any;
+        getPlaceholder: () => any;
+        defaultGroup: {
+            id: string;
+            getName: () => any;
+        };
+        getItemName: () => any;
+        getGroupEmptyLabel: () => any;
+        getGroupLoadingLabel: () => any;
+    };
+    PROGRAM_INDICATOR: {
+        id: string;
+        getName: () => any;
+        getGroupLabel: () => any;
+        getPlaceholder: () => any;
+        defaultGroup: {
+            id: string;
+            getName: () => any;
+        };
+        getItemName: () => any;
+        getGroupEmptyLabel: () => any;
+        getGroupLoadingLabel: () => any;
+    };
+};
+export declare function defaultGroupId(dataType: DataDimensionType): string;
+export declare function defaultGroupDetail(dataType: DataDimensionType): any;
+export declare const DEFAULT_DATATYPE_ID = "INDICATOR";

package/build/types/components/PivotTable/constants/pivotTable.d.ts

@@ -0,0 +1,29 @@
+export declare const SORT_ORDER_ASCENDING = 1;
+export declare const SORT_ORDER_DESCENDING = -1;
+export declare const CELL_TYPE_VALUE = "value";
+export declare const CELL_TYPE_SUBTOTAL = "subtotal";
+export declare const CELL_TYPE_TOTAL = "total";
+export declare const AGGREGATE_TYPE_SUM = "SUM";
+export declare const AGGREGATE_TYPE_AVERAGE = "AVERAGE";
+export declare const AGGREGATE_TYPE_NA = "N/A";
+export declare const NUMBER_TYPE_VALUE = "VALUE";
+export declare const NUMBER_TYPE_ROW_PERCENTAGE = "ROW_PERCENTAGE";
+export declare const NUMBER_TYPE_COLUMN_PERCENTAGE = "COLUMN_PERCENTAGE";
+export declare const BORDER_COLOR = "#b2b2b2";
+export declare const FONT_SIZE_OPTION_SMALL = "SMALL";
+export declare const FONT_SIZE_SMALL = 10;
+export declare const FONT_SIZE_OPTION_NORMAL = "NORMAL";
+export declare const FONT_SIZE_NORMAL = 11;
+export declare const FONT_SIZE_OPTION_LARGE = "LARGE";
+export declare const FONT_SIZE_LARGE = 13;
+export declare const DISPLAY_DENSITY_OPTION_COMPACT = "COMPACT";
+export declare const DISPLAY_DENSITY_PADDING_COMPACT = 4;
+export declare const DISPLAY_DENSITY_OPTION_NORMAL = "NORMAL";
+export declare const DISPLAY_DENSITY_PADDING_NORMAL = 5;
+export declare const DISPLAY_DENSITY_OPTION_COMFORTABLE = "COMFORTABLE";
+export declare const DISPLAY_DENSITY_PADDING_COMFORTABLE = 7;
+export declare const CLIPPED_CELL_MAX_SIZE = 360;
+export declare const CLIPPED_CELL_MIN_SIZE = 36;
+export declare const WRAPPED_TEXT_JUSTIFY_BUFFER = 25;
+export declare const WRAPPED_TEXT_LINE_HEIGHT = 1;
+export declare const CLIPPED_AXIS_PARTITION_SIZE_PX = 1000;

package/build/types/components/PivotTable/constants/predefinedDimensions.d.ts

@@ -0,0 +1,80 @@
+/// <reference types="react" />
+export declare const DIMENSION_ID_DATA = "dx";
+export declare const DIMENSION_ID_PERIOD = "pe";
+export declare const DIMENSION_ID_ORGUNIT = "ou";
+export declare const DIMENSION_ID_ASSIGNED_CATEGORIES = "co";
+export declare const DIMENSION_PROP_NO_ITEMS = "noItems";
+export declare const getFixedDimensions: () => {
+    dx: {
+        id: string;
+        name: any;
+        iconName: string;
+        icon: any;
+    };
+    pe: {
+        id: string;
+        name: any;
+        iconName: string;
+        icon: any;
+    };
+    ou: {
+        id: string;
+        name: any;
+        iconName: string;
+        icon: any;
+    };
+};
+export declare const getDynamicDimensions: () => {
+    co: {
+        id: string;
+        name: any;
+        iconName: string;
+        icon: () => JSX.Element;
+        noItems: boolean;
+    };
+};
+export declare const getPredefinedDimensions: () => {
+    co: {
+        id: string;
+        name: any;
+        iconName: string;
+        icon: () => JSX.Element;
+        noItems: boolean;
+    };
+    dx: {
+        id: string;
+        name: any;
+        iconName: string;
+        icon: any;
+    };
+    pe: {
+        id: string;
+        name: any;
+        iconName: string;
+        icon: any;
+    };
+    ou: {
+        id: string;
+        name: any;
+        iconName: string;
+        icon: any;
+    };
+};
+export declare const filterOutPredefinedDimensions: (dimensionIds: string[]) => string[];
+export declare const getPredefinedDimensionProp: (dimensionId: "ou" | "pe" | "dx", propName: "id" | "name" | "iconName") => any;
+export declare const getDimensionById: (dimensionId: "ou" | "pe" | "dx") => {
+    id: string;
+    name: any;
+    iconName: string;
+    icon: any;
+} | {
+    id: string;
+    name: any;
+    iconName: string;
+    icon: any;
+} | {
+    id: string;
+    name: any;
+    iconName: string;
+    icon: any;
+};

package/build/types/components/PivotTable/constants/valueTypes.d.ts

@@ -0,0 +1,22 @@
+export declare const VALUE_TYPE_NUMBER = "NUMBER";
+export declare const VALUE_TYPE_UNIT_INTERVAL = "UNIT_INTERVAL";
+export declare const VALUE_TYPE_PERCENTAGE = "PERCENTAGE";
+export declare const VALUE_TYPE_INTEGER = "INTEGER";
+export declare const VALUE_TYPE_INTEGER_POSITIVE = "INTEGER_POSITIVE";
+export declare const VALUE_TYPE_INTEGER_NEGATIVE = "INTEGER_NEGATIVE";
+export declare const VALUE_TYPE_INTEGER_ZERO_OR_POSITIVE = "INTEGER_ZERO_OR_POSITIVE";
+export declare const VALUE_TYPE_TEXT = "TEXT";
+export declare const VALUE_TYPE_LONG_TEXT = "LONG_TEXT";
+export declare const VALUE_TYPE_LETTER = "LETTER";
+export declare const VALUE_TYPE_PHONE_NUMBER = "PHONE_NUMBER";
+export declare const VALUE_TYPE_EMAIL = "EMAIL";
+export declare const VALUE_TYPE_USERNAME = "USERNAME";
+export declare const VALUE_TYPE_URL = "URL";
+export declare const VALUE_TYPE_BOOLEAN = "BOOLEAN";
+export declare const VALUE_TYPE_TRUE_ONLY = "TRUE_ONLY";
+export declare const VALUE_TYPE_DATE = "DATE";
+export declare const VALUE_TYPE_TIME = "TIME";
+export declare const VALUE_TYPE_DATETIME = "DATETIME";
+export declare const VALUE_TYPE_ORGANISATION_UNIT = "ORGANISATION_UNIT";
+export declare const VALUE_TYPE_AGE = "AGE";
+export declare const isNumericValueType: (type: string) => boolean;

package/build/types/components/PivotTable/hooks/useParentSize.d.ts

@@ -0,0 +1,8 @@
+import { useRef } from 'react';
+export declare const useParentSize: (elementRef: ReturnType<typeof useRef<HTMLElement | null>>, renderCounter: number, initialSize?: {
+    width: number;
+    height: number;
+}) => {
+    width: number;
+    height: number;
+};

package/build/types/components/PivotTable/hooks/useScrollPosition.d.ts

@@ -0,0 +1,5 @@
+import { useRef } from 'react';
+export declare const useScrollPosition: (containerRef: ReturnType<typeof useRef<HTMLElement | null>>, debounceWait?: number) => {
+    x: number;
+    y: number;
+};

package/build/types/components/PivotTable/hooks/useSortableColumns.d.ts

@@ -0,0 +1,8 @@
+import { PivotTableEngine } from "../services/engine";
+export declare const useSortableColumns: (engine: PivotTableEngine) => {
+    sortBy: {
+        order: number;
+        column: number;
+    } | null;
+    onSortByColumn: (column: number) => void;
+};

package/build/types/components/PivotTable/hooks/useTableClipping.d.ts

@@ -0,0 +1,24 @@
+import { useRef } from 'react';
+import { PivotTableEngine } from "../services/engine";
+export interface UseTableClippingParams {
+    containerRef: ReturnType<typeof useRef<HTMLElement | null>>;
+    width: number;
+    height: number;
+    engine: PivotTableEngine;
+}
+export declare const useTableClipping: ({ containerRef, width, height, engine }: UseTableClippingParams) => {
+    rows: {
+        indices: number[];
+        pre: any;
+        post: number;
+    };
+    columns: {
+        indices: number[];
+        pre: any;
+        post: number;
+    };
+    scrollPosition: {
+        x: number;
+        y: number;
+    };
+};

package/build/types/components/PivotTable/index.d.ts

@@ -0,0 +1,26 @@
+/// <reference types="react" />
+import { Analytics, LegendSet } from "@hisptz/dhis2-utils";
+import { DHIS2Dimension } from "./interfaces";
+export * from "./interfaces";
+export interface CustomPivotTableProps {
+    analytics: Analytics;
+    config: {
+        layout: {
+            columns: Array<DHIS2Dimension>;
+            rows: Array<DHIS2Dimension>;
+            filter?: Array<DHIS2Dimension>;
+        };
+        options?: {
+            legendSets?: LegendSet[];
+            hideEmptyColumns?: boolean;
+            hideEmptyRows?: boolean;
+            showRowTotals?: boolean;
+            showColumnTotals?: boolean;
+            showRowSubtotals?: boolean;
+            showColumnSubtotals?: boolean;
+            fixColumnHeaders?: boolean;
+            fixRowHeaders?: boolean;
+        };
+    };
+}
+export declare function CustomPivotTable({ analytics, config }: CustomPivotTableProps): JSX.Element;

package/build/types/components/PivotTable/interfaces/index.d.ts

@@ -0,0 +1,72 @@
+import { AnalyticsItem } from "@hisptz/dhis2-utils";
+export type ToggleContextualMenuFunction = (ref: HTMLTableCellElement | null, params: {
+    ouId?: string;
+}) => void;
+export type DHIS2Dimension = "ou" | "pe" | "dx";
+export interface ClippingResult {
+    columns: Record<string, any>;
+    rows: Record<string, any>;
+}
+export interface AxisClippingResult {
+    [key: string]: any;
+}
+export interface PivotTableVisualization {
+    showHierarchy?: boolean;
+    rows: {
+        dimension: DHIS2Dimension;
+    }[];
+    filter: {
+        dimension: DHIS2Dimension;
+    }[];
+    columns: {
+        dimension: DHIS2Dimension;
+    }[];
+    colTotals?: number;
+    rowTotals?: number;
+    colSubTotals?: number;
+    rowSubTotals?: number;
+    hideEmptyColumns?: boolean;
+    hideEmptyRows?: boolean;
+    hideTitle?: boolean;
+    title?: string;
+    hideSubtitle?: boolean;
+    subtitle?: string;
+    fixColumnHeaders?: boolean;
+    fixRowHeaders?: boolean;
+    showDimensionLabels?: boolean;
+}
+export interface DimensionLookupItem {
+    dimension: DHIS2Dimension;
+    meta: AnalyticsItem;
+    count?: number;
+    itemIds: string[];
+    items: AnalyticsItem[];
+    isDxDimension: boolean;
+    position: "column" | "row";
+    size?: number;
+}
+export interface DimensionLookup {
+    rows: Array<DimensionLookupItem & {
+        position: "row";
+    }>;
+    columns: Array<DimensionLookupItem & {
+        position: "column";
+    }>;
+    allByDimension: {
+        [key: string]: DimensionLookupItem;
+    };
+    headerDimensions: DimensionLookupItem[];
+    rowHeaders: {}[];
+    columnHeaders: {}[];
+    dataHeaders: Record<string, number>;
+}
+export interface PivotTableOptions {
+    hideEmptyColumns: boolean;
+    hideEmptyRows: boolean;
+    showRowTotals: boolean;
+    showColumnTotals: boolean;
+    showRowSubtotals: boolean;
+    showColumnSubtotals: boolean;
+    fixColumnHeaders: boolean;
+    fixRowHeaders: boolean;
+}

package/build/types/components/PivotTable/services/adaptiveClippingController.d.ts

@@ -0,0 +1,44 @@
+import { PivotTableEngine } from "./engine";
+export interface AxisInterface {
+    sizes: {
+        size: number;
+        pre: number;
+    }[];
+    headerSizes?: any;
+    headerSize: any;
+    orientation?: "column" | "row";
+    totalSize: number;
+    partitions: number[];
+}
+export declare class AdaptiveClippingController {
+    columns: AxisInterface;
+    rows: AxisInterface;
+    engine: PivotTableEngine;
+    constructor(engine: PivotTableEngine);
+    addSize({ row, column }: {
+        row: number;
+        column: number;
+    }, { width, height }: {
+        width: number;
+        height: number;
+    }): void;
+    add({ row, column }: {
+        row: number;
+        column: number;
+    }, renderedValue?: string): void;
+    measureText(renderedValue?: string, options?: any): {
+        width: number;
+        height: number;
+        normalizedText?: undefined;
+    } | {
+        normalizedText: string;
+        width: number;
+        height: number;
+    };
+    getCellSize(contentSize: number): number;
+    finalizeAxis(axis: AxisInterface): void;
+    populateAxisPartitions(axis: AxisInterface): void;
+    resetRowPartitions(): void;
+    finalize(): void;
+    reset(): void;
+}