@cellaware/utils 8.11.19 → 8.11.20

package/dist/chatwms/datagrid.d.ts

@@ -0,0 +1,215 @@
+export declare const DATAGRID_HTML_ROWS = 1000;
+export declare const DATAGRID_HTML_COLS = 8;
+export declare const DATAGRID_TEAMS_ROWS = 24;
+export interface DatagridStateBase {
+    columnState?: ColumnState[];
+    columnGroupState?: any[];
+    isPivotMode?: boolean;
+    filterModel?: FilterModel;
+    columnFormats?: ColumnFormat[];
+}
+export interface DatagridState extends DatagridStateBase {
+    adjRows: any[];
+}
+export declare function initDatagridState(): DatagridState;
+export interface VisualDatagridState extends DatagridState {
+    chartRows: any[];
+    html: string;
+    teamsRows: any[];
+    htmlTranspose: string;
+    teamsTranspose: any[];
+}
+export declare function initVisualDatagridState(): VisualDatagridState;
+export type ColumnState = {
+    /** Maps to ColumnFormat `name`. */
+    colId: string;
+    hide?: boolean | null;
+    sort?: 'asc' | 'desc' | null;
+    sortIndex?: number | null;
+    aggFunc?: string | null;
+    pivot?: boolean;
+    pivotIndex?: number | null;
+    rowGroup?: boolean;
+    rowGroupIndex?: number | null;
+    pinned?: 'left' | 'right' | null;
+};
+type FilterType = 'text' | 'number' | 'set';
+type Operator = 'AND' | 'OR';
+type SimpleCondition = {
+    filterType: FilterType;
+    type: string;
+    filter?: any;
+    filterTo?: any;
+    values?: any[];
+};
+type CompoundFilter = {
+    filterType: FilterType;
+    operator: Operator;
+    conditions: SimpleCondition[];
+};
+type ColumnFilter = SimpleCondition | CompoundFilter;
+type FilterModel = Record<string, ColumnFilter>;
+export interface ColumnFormat {
+    /** Maps to ColumnState `colId`. */
+    name: string;
+    displayName: string;
+    /** `text` | `number` | `date` | `boolean` */
+    type: string;
+    valueFormat: ValueFormat;
+    conditionalFormats: ConditionalFormat[];
+}
+export declare const DEFAULT_VALUE_FORMAT_VALUE = "none";
+export interface ValueFormat {
+    /** `none` | `lower` | `upper` | `title` */
+    txtCaseVal: string;
+    /** `none` | `0` | `1` | `2` | `3` | `4` */
+    numRoundVal: string;
+    /** `none` | `on` */
+    numCommaVal: string;
+    /** `none` | `dollar` */
+    numCurrencyVal: string;
+    /** `none` | `1` | `100` */
+    numPercentVal: string;
+    /** `none` | `slash` | `dash` */
+    dteSeparatorVal: string;
+    /** `none` | `numeric` | `2-digit` */
+    dteYearVal: string;
+    /** `none` | `numeric` | `2-digit` | `long` | `short` */
+    dteMonthVal: string;
+    /** `none` | `numeric` | `2-digit` */
+    dteDayVal: string;
+    /** `none` | `long` | `short` */
+    dteWeekdayVal: string;
+    /** `none` | `h12` | `h24` (we will translate to `h23`) */
+    dteHourcycleVal: string;
+    /** `none` | `numeric` | `2-digit` */
+    dteHourVal: string;
+    /** `none` | `numeric` | `2-digit` */
+    dteMinuteVal: string;
+    /** `none` | `numeric` | `2-digit` */
+    dteSecondVal: string;
+}
+export declare function evaluateValueFormat(colFmt: ColumnFormat, value: any, locale: string): any;
+export declare function formatNumberEnabled(fmt: ValueFormat): boolean;
+export declare enum ConditionalFormatRule {
+    CONTAINS = "conditional-format-rule-contains",
+    DOES_NOT_CONTAIN = "conditional-format-rule-does-not-contain",
+    BEGINS_WITH = "conditional-format-rule-begins-with",
+    ENDS_WITH = "conditional-format-rule-ends-with",
+    GREATER_THAN = "conditional-format-rule-greater-than",
+    GREATER_THAN_OR_EQUAL_TO = "conditional-format-rule-greater-than-or-equal-to",
+    LESS_THAN = "conditional-format-rule-less-than",
+    LESS_THAN_OR_EQUAL_TO = "conditional-format-rule-less-than-or-equal-to",
+    BETWEEN = "conditional-format-rule-between",
+    EQUALS = "conditional-format-rule-equals",
+    DOES_NOT_EQUAL = "conditional-format-rule-does-not-equal",
+    BLANK = "conditional-format-rule-blank",
+    NOT_BLANK = "conditional-format-rule-not-blank"
+}
+export declare const CONDITIONAL_FORMAT_RULES: string[];
+export declare const CONDITIONAL_FORMAT_RULES_TEXT: string[];
+export declare const CONDITIONAL_FORMAT_RULES_NUMBER: string[];
+export declare const CONDITIONAL_FORMAT_RULES_BOOLEAN: string[];
+export declare enum ConditionalFormatStyle {
+    NONE = "conditional-format-style-none",
+    GREEN_BACKGROUND = "conditional-format-style-green-background",
+    YELLOW_BACKGROUND = "conditional-format-style-yellow-background",
+    RED_BACKGROUND = "conditional-format-style-red-background",
+    BLUE_BACKGROUND = "conditional-format-style-blue-background",
+    PURPLE_BACKGROUND = "conditional-format-style-purple-background",
+    BOLD = "conditional-format-style-bold",
+    GREEN_BOLD = "conditional-format-style-green-bold",
+    YELLOW_BOLD = "conditional-format-style-yellow-bold",
+    RED_BOLD = "conditional-format-style-red-bold",
+    BLUE_BOLD = "conditional-format-style-blue-bold",
+    PURPLE_BOLD = "conditional-format-style-purple-bold",
+    NOT_IMPORTANT = "conditional-format-style-not-important"
+}
+export interface ConditionalFormat {
+    sequence: number;
+    rule: string;
+    value: string;
+    value2?: string;
+    style: string;
+    row: boolean;
+}
+export declare function evaluateConditionalFormat(condFmt: ConditionalFormat, dataType: string, value: any): boolean;
+export declare function evaluateValueStyles(datagridState: DatagridStateBase, columnName: string, value: any): string[];
+export interface DatagridCondition {
+    columnName: string;
+    /** `text` | `number` | `date` | `boolean` */
+    dataType: string;
+    rule: string;
+    value: string;
+    value2?: string;
+}
+export declare function initDatagridCondition(): DatagridCondition;
+export declare function summarizeCondition(condition: DatagridCondition, localeMessageFn: (language: string, messageId: string) => Promise<string>): Promise<string>;
+export declare function summarizeConditionMarkdown(condition: DatagridCondition, localeMessageFn: (language: string, messageId: string) => Promise<string>): Promise<string>;
+export declare function summarizeConditionHtml(condition: DatagridCondition, localeMessageFn: (language: string, messageId: string) => Promise<string>): Promise<string>;
+export declare function codifyCondition(condition: DatagridCondition): string;
+/**
+ * Equivalent of `parseNumeric` in front end
+ *
+ * https://github.com/cellaware/chatwms-az-swa-ng/blob/development/src/app/utils/data.ts#L126
+ */
+export declare function stripNumericValueFormat(value: string | number | null | undefined): any;
+interface HtmlColumnStyle {
+    columnName: string;
+    styles: string[];
+}
+interface TeamsColumnStyleAttributes {
+    color?: string;
+    style?: string;
+    weight?: string;
+    isSubtle?: boolean;
+    italic?: boolean;
+}
+export interface TeamsColumnStyle {
+    columnName: string;
+    styles: TeamsColumnStyleAttributes[];
+}
+export declare function mapTeamsStyles(columnNames: string[], htmlRowStyles: string[], htmlColumnStyles: HtmlColumnStyle[], teamsRowStyles: string[], teamsColumnStyles: TeamsColumnStyle[]): [string[], TeamsColumnStyle[]];
+export declare function mapTeamsTransposeStyles(htmlColumnStyle: HtmlColumnStyle): TeamsColumnStyle;
+export declare function createTeamsTableColumns(columnNames: string[]): {
+    type: string;
+    cells: {
+        type: string;
+        items: {
+            type: string;
+            text: any;
+            size: string;
+            weight: string;
+        }[];
+    }[];
+};
+export declare function createTeamsTableRow(columnNames: string[], values: any[], rowStyles?: string[], columnStyles?: TeamsColumnStyle[]): {
+    type: string;
+    style: string | undefined;
+    cells: {
+        type: string;
+        style: string | undefined;
+        items: {
+            type: string;
+            text: any;
+            size: string;
+            color: string | undefined;
+            weight: string | undefined;
+            isSubtle: true | undefined;
+        }[];
+    }[];
+};
+export declare function createTeamsTransposeTableRow(row: {
+    key: string;
+    value: any;
+}, columnStyle: TeamsColumnStyle): {
+    type: string;
+    cells: any[];
+};
+/**
+ * **Important:** `html` and `teamsRows` output will be limited to **1,000 rows/24 rows** and **8 columns**, respectively.
+ *
+ * ~All outputs respect and will be filtered by optional `condition` argument.~
+ */
+export declare function transformDatagrid(rows: any[], datagridState: DatagridStateBase, locale: string, condition?: DatagridCondition): VisualDatagridState;
+export {};