caplink-saas-ui-shared-component-library 0.3.0 → 0.3.2

package/dist/index.d.ts

@@ -1,323 +1,7 @@
-import { JSX as JSX_2 } from 'react/jsx-runtime';
-import { MouseEvent as MouseEvent_2 } from 'react';
-import { PropsWithChildren } from 'react';
-
-export declare const CapLink: {
-    Spreadsheet: typeof Spreadsheet;
-};
-
-/** Spreadsheet Cell component */
-declare type Cell = {
-    /** The cell value */
-    value?: unknown;
-    /** Point coordinates of the cell */
-    coordinates: MatrixTypes.Point;
-    width: number;
-};
-
-/** Spreadsheet cell initial height */
-declare const CELL_INITIAL_HEIGHT = 26;
-
-/** Spreadsheet column meta data and settings */
-declare type Column = {
-    /** Column identifier */
-    id: string;
-    /** Column name to be displayed */
-    name: string;
-    /** Column tooltip description */
-    description?: string;
-    /** Column position */
-    position: number;
-    /** Column data editor type */
-    dataEditorType: DataEditorType;
-    /** Alphabet letter by position */
-    alphabetLetter?: string;
-    /** Column element states  */
-    state: ColumnState;
-    /** Column settings  */
-    settings?: ColumnSettings;
-};
-
-/** Spreadsheet column initial width */
-declare const COLUMN_INITIAL_WIDTH = 160;
-
-/** Spreadsheet column max width */
-declare const COLUMN_MAX_WIDTH = 480;
-
-/** Spreadsheet column min width */
-declare const COLUMN_MIN_WIDTH: number;
-
-/** Spreadsheet column title single char length */
-declare const COLUMN_TITLE_CHAR_LENGTH = 12;
-
-declare const COLUMN_TITLE_CONTAINER_PADDING_X = 16;
-
-declare const COLUMN_TITLE_ICON_WIDTH = 16;
-
-/** Spreadsheet column title initial height */
-declare const COLUMN_TITLE_INITIAL_HEIGHT = 36;
-
-declare type ColumnSettings = {
-    select?: {
-        items: Array<SelectItem>;
-    };
-    numeric?: {
-        min?: number;
-        max?: number;
-        allowNegative?: boolean;
-        roundingRule?: string;
-        decimalScale?: number;
-        currency?: string;
-    };
-    string?: {
-        maskData?: string;
-        maskVisible?: boolean;
-        charLimit?: number;
-    };
-};
-
-declare type ColumnState = {
-    /** Whether column is readonly to user */
-    readonly?: boolean;
-    /** Whether column is visible to user */
-    visible?: boolean;
-    /** Column width in px */
-    width: number;
-};
-
-declare type Context = {
-    size: MatrixTypes.Size;
-    matrix: MatrixTypes.Matrix<unknown>;
-    columns: Column[];
-    emptySize: boolean;
-    /** Defines if user can add or delete rows */
-    staticRows?: boolean;
-    hasSomeEntireRow?: boolean;
-    /** Whether last row is highlighted */
-    highlightLastRow?: boolean;
-    pointRange: MatrixTypes.PointRange | null;
-    setPointRange: (pointRange: MatrixTypes.PointRange | null) => void;
-    containerDimensions: Dimensions;
-    setContainerDimensions: (dimensions: Dimensions) => void;
-    onPaste: (point: MatrixTypes.Point) => void;
-    onChange: (params: {
-        data: unknown;
-        point: MatrixTypes.Point;
-    }) => void;
-    onRemoveRow: () => void;
-    onSelectRow: (row: number, event?: MouseEvent_2) => void;
-    onSelectCell: (point: MatrixTypes.Point) => void;
-    isCellSelected: (point: MatrixTypes.Point) => boolean;
-    onInsertNewRow: () => void;
-    onColumnResize: (params: {
-        width: number;
-        position: number;
-    }) => void;
-    onSelectSpreadsheet: () => void;
-    onColumnVisibilityChange: (params: {
-        columnId: string;
-        visible?: boolean;
-    }) => void;
-    onRestoreColumnsVisibility: () => void;
-};
-
-declare type ContextProvider = Omit<PropsWithChildren<Props>, 'className'>;
-
-/** Creates an empty matrix with given rows and columns */
-declare function createEmpty<T>(size: Size, fill?: T): Matrix<T>;
-
-declare type DataEditor = {
-    mode: Mode;
-    /** Data editor current value */
-    value?: unknown;
-    /** Whether data editor data changes */
-    onChange?: ({ data, point }: {
-        data: unknown;
-        point?: MatrixTypes.Point;
-    }) => void;
-    /** Whether user paste any value on data editor */
-    onPaste?: (point?: MatrixTypes.Point) => void;
-    /** Whether user blur current data editor */
-    onBlur?: () => void;
-    /** Whether user clicks current data editor */
-    onClick?: <T>(e: MouseEvent_2<T>) => void;
-    /** Cell mode setter */
-    setMode?: (mode: Mode) => void;
-    selected?: boolean;
-    column: Column;
-    width: number;
-    coordinates: MatrixTypes.Point;
-};
-
-/** Cell data editor type */
-declare type DataEditorType = 'Boolean' | 'String' | 'Select' | 'Date' | 'Integer' | 'Currency' | 'Float' | 'Decimal' | 'Percentage';
-
-declare type DataViewer = {
-    width: number;
-    mode: Mode;
-    /** Data viewer current value */
-    value?: unknown;
-    column: Column;
-    coordinates: MatrixTypes.Point;
-    selected?: boolean;
-};
-
-/** Dimensions of an element */
-declare type Dimensions = {
-    /** The element's width in pixels */
-    width: number;
-    /** The element's height in pixels */
-    height: number;
-};
-
-/** Gets the count of columns of given matrix */
-declare function getColumnsCount(matrix: Matrix<unknown>): number;
-
-/** Gets the value at row and column of matrix. */
-declare function getPoint<T>(params: {
-    point: Point;
-    matrix: Matrix<T>;
-}): T | undefined;
-
-/** Gets the count of rows of given matrix */
-declare function getRowsCount(matrix: Matrix<unknown>): number;
-
-/** Gets the count of rows and columns of given matrix */
-declare function getSize(matrix: Matrix<unknown>): Size;
-
-/** Determines whether all columns are selected */
-declare function hasEntireColumns(params: {
-    matrix: Matrix<unknown>;
-    pointRange: PointRange;
-}): boolean;
-
-/** Determines which row is entirely selected in given selection */
-declare function hasEntireRows(params: {
-    matrix: Matrix<unknown>;
-    pointRange: PointRange;
-    row: number;
-}): boolean;
-
-/** Returns whether given point exists in given range */
-declare function hasPointInRange(pointRange: PointRange, point: Point): boolean;
-
-/** Initial column params before spreadsheet internal setup */
-declare type InitialColumn = Pick<Column, Exclude<keyof Column, 'alphabetLetter' | 'position' | 'width'>>;
-
-/** Checks if the source and target point are equal */
-declare function isSamePoint(source: Point, target: Point): boolean;
-
-declare type Matrix<T> = Array<Array<T | undefined>>;
-
-declare namespace MatrixTypes {
-    export {
-        createEmpty,
-        getRowsCount,
-        getColumnsCount,
-        getSize,
-        getPoint,
-        isSamePoint,
-        hasPointInRange,
-        hasEntireColumns,
-        hasEntireRows,
-        parseString,
-        overlap,
-        Point,
-        PointRange,
-        Size,
-        Matrix
-    }
-}
-export { MatrixTypes }
-
-/** The mode of the cell */
-declare type Mode = 'edit' | 'readonly' | 'view';
-
-declare const NUMERIC_DATA_EDITOR_TYPES: readonly DataEditorType[];
-
-/**
- * Overlaps a given Matrix B (mB) starting in a specific point into a given Matrix A (mA)
- * Matrix B (mB) always has priority when replacing cell values
- */
-declare function overlap(params: {
-    mA: Matrix<unknown>;
-    mB: Matrix<unknown>;
-    point: Point;
-}): Matrix<unknown>;
-
-/** Converts string value into an matrix */
-declare function parseString(value: string): Matrix<unknown>;
-
-/** A cell cordinates in matrix */
-declare type Point = {
-    row: number;
-    column: number;
-};
-
-/** Range between two points. */
-declare type PointRange = {
-    /** The top-left point */
-    start: Point;
-    /** The bottom-right point */
-    end: Point;
-};
-
-declare type Props = {
-    matrix: MatrixTypes.Matrix<unknown>;
-    onMatrixChange?: (matrix: MatrixTypes.Matrix<unknown>) => void;
-    startingColumns: InitialColumn[];
-    /** Defines if user can add or delete rows */
-    staticRows?: boolean;
-    className?: string;
-};
-
-/** Select component item props */
-declare type SelectItem = {
-    text: string;
-    value: string;
-};
-
-/** Spreadsheet columns internal states and values setup function */
-declare function setupColumns(columns: InitialColumn[]): Column[];
-
-/** Counts of the rows and column in a matrix */
-declare type Size = {
-    /** Count of the rows in the matrix */
-    rows: number;
-    /** Count of the columns in the matrix */
-    columns: number;
-};
-
-declare function Spreadsheet(props: Props): JSX_2.Element;
-
-declare namespace SpreadsheetTypes {
-    export {
-        setupColumns,
-        COLUMN_TITLE_CONTAINER_PADDING_X,
-        COLUMN_TITLE_ICON_WIDTH,
-        COLUMN_INITIAL_WIDTH,
-        COLUMN_MAX_WIDTH,
-        COLUMN_MIN_WIDTH,
-        COLUMN_TITLE_CHAR_LENGTH,
-        COLUMN_TITLE_INITIAL_HEIGHT,
-        CELL_INITIAL_HEIGHT,
-        NUMERIC_DATA_EDITOR_TYPES,
-        Dimensions,
-        SelectItem,
-        Mode,
-        DataEditorType,
-        DataEditor,
-        DataViewer,
-        ColumnState,
-        ColumnSettings,
-        Column,
-        InitialColumn,
-        Cell,
-        Props,
-        Context,
-        ContextProvider
-    }
-}
-export { SpreadsheetTypes }
-
-export { }
+import { Spreadsheet } from './components/spreadsheet/ui';
+import { MatrixTypes, SpreadsheetTypes } from './types';
+
+export declare const CapLink: {
+    Spreadsheet: typeof Spreadsheet;
+};
+export type { MatrixTypes, SpreadsheetTypes };