semaphor 0.0.115 → 0.0.117

package/dist/surfboard/index.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("../chunks/dashboard-plus-mEznHmO7.js"),r=require("../types/index.cjs");exports.Surfboard=e.DashboardPlus;exports.EMPTY_SELECTION=r.EMPTY_SELECTION;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("../chunks/dashboard-plus-D7xUisoo.js"),r=require("../types/index.cjs");exports.Surfboard=e.DashboardPlus;exports.EMPTY_SELECTION=r.EMPTY_SELECTION;

package/dist/surfboard/index.js

@@ -1,4 +1,4 @@
-import { D as f } from "../chunks/dashboard-plus-Dq0emGUx.js";
+import { D as f } from "../chunks/dashboard-plus-CdWL_lpU.js";
 import { EMPTY_SELECTION as a } from "../types/index.js";
 export {
   a as EMPTY_SELECTION,

package/dist/types/dashboard.d.ts

@@ -26,6 +26,25 @@ export declare type AuthToken = {
     refreshToken?: string;
 };
 
+export declare type AxisConfig = {
+    enabled?: boolean;
+    name?: {
+        enabled: boolean;
+        text?: string;
+    };
+    position?: 'auto' | 'top' | 'bottom' | 'left' | 'right';
+    labels?: {
+        enabled: boolean;
+        rotation?: 'auto' | 0 | 45 | 90 | -45 | -90;
+    };
+    formatOptions?: TFormatOptions;
+    scale?: {
+        min?: number | 'auto';
+        max?: number | 'auto';
+        stepSize?: number | 'auto';
+    };
+};
+
 declare interface BaseColumn {
     id: string;
     name: string;
@@ -152,6 +171,10 @@ declare interface ClickFilterInteraction {
     label?: string;
 }
 
+export declare type ColorConfig = {
+    segments: Record<string, string>;
+};
+
 export declare type ColorRange = {
     start: number;
     end: number;
@@ -587,7 +610,9 @@ declare interface MetricField extends Field {
      }
      }
      */
-    parameters?: Record<string, any>;
+    parameters?: {
+        filters?: FilterGroup;
+    };
     aliasTemplate?: string;
     valueAliases?: Record<string, string>;
 }
@@ -809,6 +834,10 @@ export declare type TCardPreferences = {
     datasetOptions?: TDatasetOptions[];
     chartOptions?: TChartOptions;
     columnSettings?: TColumnSetting<DisplayDataType>[];
+    colorConfig?: ColorConfig;
+    xAxisConfig?: AxisConfig;
+    yAxisConfig?: AxisConfig;
+    dataLabelsConfig?: TDataLabelsConfig;
     tablePrefs?: TablePreferences;
     allowDownload?: boolean;
     customVisualCode?: string;
@@ -828,6 +857,27 @@ export declare type TCardPreferences = {
     kpiVisualOptions?: {
         lowerIsBetter?: boolean;
         countryLogoId?: string;
+        formatOptions?: TFormatOptions;
+        metricComparison?: {
+            enabled?: boolean;
+            calculationType?: 'difference' | 'change' | 'change_difference' | 'ratio';
+            formatOptions?: TFormatOptions;
+            showArrow?: boolean;
+            showColor?: boolean;
+            conditionalLabel?: boolean;
+            labelName?: string;
+            position?: 'left' | 'right' | 'top';
+            conditionalLabels?: {
+                increase?: string;
+                decrease?: string;
+                noChange?: string;
+            };
+            colorConfig?: {
+                increase?: 'green' | 'red' | 'neutral' | string;
+                decrease?: 'green' | 'red' | 'neutral' | string;
+                noChange?: 'green' | 'red' | 'neutral' | string;
+            };
+        };
     };
     pivotTableOptions?: {
         showRowTotals?: boolean;
@@ -928,6 +978,25 @@ export declare type TDataColumn = {
     description?: string;
 };
 
+export declare type TDataLabelsConfig = {
+    enabled?: boolean;
+    position?: 'center' | 'top' | 'bottom' | 'left' | 'right' | 'auto' | 'custom';
+    anchor?: 'center' | 'start' | 'end';
+    align?: 'center' | 'start' | 'end' | 'top' | 'bottom' | number;
+    display?: 'auto' | boolean;
+    format?: 'auto' | 'number' | 'currency' | 'percent' | 'none';
+    formatOptions?: TFormatOptions;
+    font?: {
+        size?: number;
+        weight?: 'normal' | 'bold';
+    };
+    color?: 'auto' | string;
+    clamp?: boolean;
+    clip?: boolean;
+    rotation?: number;
+    showTotal?: boolean;
+};
+
 export declare type TDatasetOptions = {
     idx: number;
     type?: 'bar' | 'line';
@@ -970,6 +1039,19 @@ declare type TFilter = {
 
 declare type TFilterValue = FilterForString | FilterForEqual | FilterForCompare | FilterForBetween | FilterForIn | FilterForDate;
 
+export declare type TFormatOptions = {
+    type?: 'auto' | 'number' | 'currency' | 'percent' | 'scientific' | 'date';
+    decimalPlaces?: number;
+    currency?: string;
+    locale?: string;
+    prefix?: string;
+    suffix?: string;
+    useSuffix?: boolean;
+    negativeInParentheses?: boolean;
+    multiplyBy?: number;
+    dateFormat?: string;
+};
+
 export declare type TFrame = {
     id: string;
     filterId?: string;

package/dist/types/main.d.ts

@@ -231,6 +231,25 @@ export declare type AuthToken = {
     refreshToken?: string;
 };
 
+export declare type AxisConfig = {
+    enabled?: boolean;
+    name?: {
+        enabled: boolean;
+        text?: string;
+    };
+    position?: 'auto' | 'top' | 'bottom' | 'left' | 'right';
+    labels?: {
+        enabled: boolean;
+        rotation?: 'auto' | 0 | 45 | 90 | -45 | -90;
+    };
+    formatOptions?: TFormatOptions;
+    scale?: {
+        min?: number | 'auto';
+        max?: number | 'auto';
+        stepSize?: number | 'auto';
+    };
+};
+
 export declare interface BaseColumn {
     id: string;
     name: string;
@@ -361,6 +380,10 @@ declare interface ClickFilterInteraction {
     label?: string;
 }
 
+export declare type ColorConfig = {
+    segments: Record<string, string>;
+};
+
 export declare type ColorRange = {
     start: number;
     end: number;
@@ -403,13 +426,6 @@ declare interface ColumnSettings {
 
 declare type ColumnSettingsMap = Record<string, ColumnSettings>;
 
-export declare interface ColumnSubtotalMeta {
-    alias: string;
-    subtotalLevel?: string;
-    isColumnSubtotal?: boolean;
-    isColumnTotal?: boolean;
-}
-
 export declare type ColumnType = 'string' | 'number' | 'date';
 
 declare type ComboBoxOption = {
@@ -1067,7 +1083,9 @@ export declare interface MetricField extends Field {
      }
      }
      */
-    parameters?: Record<string, any>;
+    parameters?: {
+        filters?: FilterGroup;
+    };
     aliasTemplate?: string;
     valueAliases?: Record<string, string>;
 }
@@ -1162,12 +1180,6 @@ export declare enum PivotMarkerEnum {
     ALL = "__ALL__"
 }
 
-export declare interface PivotRowMetadata {
-    isSubtotal?: boolean;
-    subtotalLevel?: string | null;
-    isGrandTotal?: boolean;
-}
-
 export declare type Placeholders = {
     /**
      * Placeholder for the card when there are no records to display.
@@ -1419,6 +1431,10 @@ export declare type TCardPreferences = {
     datasetOptions?: TDatasetOptions[];
     chartOptions?: TChartOptions;
     columnSettings?: TColumnSetting<DisplayDataType>[];
+    colorConfig?: ColorConfig;
+    xAxisConfig?: AxisConfig;
+    yAxisConfig?: AxisConfig;
+    dataLabelsConfig?: TDataLabelsConfig;
     tablePrefs?: TablePreferences;
     allowDownload?: boolean;
     customVisualCode?: string;
@@ -1438,6 +1454,27 @@ export declare type TCardPreferences = {
     kpiVisualOptions?: {
         lowerIsBetter?: boolean;
         countryLogoId?: string;
+        formatOptions?: TFormatOptions;
+        metricComparison?: {
+            enabled?: boolean;
+            calculationType?: 'difference' | 'change' | 'change_difference' | 'ratio';
+            formatOptions?: TFormatOptions;
+            showArrow?: boolean;
+            showColor?: boolean;
+            conditionalLabel?: boolean;
+            labelName?: string;
+            position?: 'left' | 'right' | 'top';
+            conditionalLabels?: {
+                increase?: string;
+                decrease?: string;
+                noChange?: string;
+            };
+            colorConfig?: {
+                increase?: 'green' | 'red' | 'neutral' | string;
+                decrease?: 'green' | 'red' | 'neutral' | string;
+                noChange?: 'green' | 'red' | 'neutral' | string;
+            };
+        };
     };
     pivotTableOptions?: {
         showRowTotals?: boolean;
@@ -1540,6 +1577,25 @@ export declare type TDataColumn = {
     description?: string;
 };
 
+export declare type TDataLabelsConfig = {
+    enabled?: boolean;
+    position?: 'center' | 'top' | 'bottom' | 'left' | 'right' | 'auto' | 'custom';
+    anchor?: 'center' | 'start' | 'end';
+    align?: 'center' | 'start' | 'end' | 'top' | 'bottom' | number;
+    display?: 'auto' | boolean;
+    format?: 'auto' | 'number' | 'currency' | 'percent' | 'none';
+    formatOptions?: TFormatOptions;
+    font?: {
+        size?: number;
+        weight?: 'normal' | 'bold';
+    };
+    color?: 'auto' | string;
+    clamp?: boolean;
+    clip?: boolean;
+    rotation?: number;
+    showTotal?: boolean;
+};
+
 export declare type TDatasetOptions = {
     idx: number;
     type?: 'bar' | 'line';
@@ -1582,6 +1638,19 @@ declare type TFilter = {
 
 export declare type TFilterValue = FilterForString | FilterForEqual | FilterForCompare | FilterForBetween | FilterForIn | FilterForDate;
 
+export declare type TFormatOptions = {
+    type?: 'auto' | 'number' | 'currency' | 'percent' | 'scientific' | 'date';
+    decimalPlaces?: number;
+    currency?: string;
+    locale?: string;
+    prefix?: string;
+    suffix?: string;
+    useSuffix?: boolean;
+    negativeInParentheses?: boolean;
+    multiplyBy?: number;
+    dateFormat?: string;
+};
+
 export declare type TFrame = {
     id: string;
     filterId?: string;

package/dist/types/surfboard.d.ts

@@ -26,6 +26,25 @@ export declare type AuthToken = {
     refreshToken?: string;
 };
 
+export declare type AxisConfig = {
+    enabled?: boolean;
+    name?: {
+        enabled: boolean;
+        text?: string;
+    };
+    position?: 'auto' | 'top' | 'bottom' | 'left' | 'right';
+    labels?: {
+        enabled: boolean;
+        rotation?: 'auto' | 0 | 45 | 90 | -45 | -90;
+    };
+    formatOptions?: TFormatOptions;
+    scale?: {
+        min?: number | 'auto';
+        max?: number | 'auto';
+        stepSize?: number | 'auto';
+    };
+};
+
 declare interface BaseColumn {
     id: string;
     name: string;
@@ -152,6 +171,10 @@ declare interface ClickFilterInteraction {
     label?: string;
 }
 
+export declare type ColorConfig = {
+    segments: Record<string, string>;
+};
+
 export declare type ColorRange = {
     start: number;
     end: number;
@@ -590,7 +613,9 @@ declare interface MetricField extends Field {
      }
      }
      */
-    parameters?: Record<string, any>;
+    parameters?: {
+        filters?: FilterGroup;
+    };
     aliasTemplate?: string;
     valueAliases?: Record<string, string>;
 }
@@ -814,6 +839,10 @@ export declare type TCardPreferences = {
     datasetOptions?: TDatasetOptions[];
     chartOptions?: TChartOptions;
     columnSettings?: TColumnSetting<DisplayDataType>[];
+    colorConfig?: ColorConfig;
+    xAxisConfig?: AxisConfig;
+    yAxisConfig?: AxisConfig;
+    dataLabelsConfig?: TDataLabelsConfig;
     tablePrefs?: TablePreferences;
     allowDownload?: boolean;
     customVisualCode?: string;
@@ -833,6 +862,27 @@ export declare type TCardPreferences = {
     kpiVisualOptions?: {
         lowerIsBetter?: boolean;
         countryLogoId?: string;
+        formatOptions?: TFormatOptions;
+        metricComparison?: {
+            enabled?: boolean;
+            calculationType?: 'difference' | 'change' | 'change_difference' | 'ratio';
+            formatOptions?: TFormatOptions;
+            showArrow?: boolean;
+            showColor?: boolean;
+            conditionalLabel?: boolean;
+            labelName?: string;
+            position?: 'left' | 'right' | 'top';
+            conditionalLabels?: {
+                increase?: string;
+                decrease?: string;
+                noChange?: string;
+            };
+            colorConfig?: {
+                increase?: 'green' | 'red' | 'neutral' | string;
+                decrease?: 'green' | 'red' | 'neutral' | string;
+                noChange?: 'green' | 'red' | 'neutral' | string;
+            };
+        };
     };
     pivotTableOptions?: {
         showRowTotals?: boolean;
@@ -933,6 +983,25 @@ export declare type TDataColumn = {
     description?: string;
 };
 
+export declare type TDataLabelsConfig = {
+    enabled?: boolean;
+    position?: 'center' | 'top' | 'bottom' | 'left' | 'right' | 'auto' | 'custom';
+    anchor?: 'center' | 'start' | 'end';
+    align?: 'center' | 'start' | 'end' | 'top' | 'bottom' | number;
+    display?: 'auto' | boolean;
+    format?: 'auto' | 'number' | 'currency' | 'percent' | 'none';
+    formatOptions?: TFormatOptions;
+    font?: {
+        size?: number;
+        weight?: 'normal' | 'bold';
+    };
+    color?: 'auto' | string;
+    clamp?: boolean;
+    clip?: boolean;
+    rotation?: number;
+    showTotal?: boolean;
+};
+
 export declare type TDatasetOptions = {
     idx: number;
     type?: 'bar' | 'line';
@@ -975,6 +1044,19 @@ declare type TFilter = {
 
 declare type TFilterValue = FilterForString | FilterForEqual | FilterForCompare | FilterForBetween | FilterForIn | FilterForDate;
 
+export declare type TFormatOptions = {
+    type?: 'auto' | 'number' | 'currency' | 'percent' | 'scientific' | 'date';
+    decimalPlaces?: number;
+    currency?: string;
+    locale?: string;
+    prefix?: string;
+    suffix?: string;
+    useSuffix?: boolean;
+    negativeInParentheses?: boolean;
+    multiplyBy?: number;
+    dateFormat?: string;
+};
+
 export declare type TFrame = {
     id: string;
     filterId?: string;

package/dist/types/types.d.ts

@@ -25,6 +25,25 @@ export declare type AuthToken = {
     refreshToken?: string;
 };
 
+export declare type AxisConfig = {
+    enabled?: boolean;
+    name?: {
+        enabled: boolean;
+        text?: string;
+    };
+    position?: 'auto' | 'top' | 'bottom' | 'left' | 'right';
+    labels?: {
+        enabled: boolean;
+        rotation?: 'auto' | 0 | 45 | 90 | -45 | -90;
+    };
+    formatOptions?: TFormatOptions;
+    scale?: {
+        min?: number | 'auto';
+        max?: number | 'auto';
+        stepSize?: number | 'auto';
+    };
+};
+
 declare interface BaseColumn {
     id: string;
     name: string;
@@ -151,6 +170,10 @@ declare interface ClickFilterInteraction {
     label?: string;
 }
 
+export declare type ColorConfig = {
+    segments: Record<string, string>;
+};
+
 export declare type ColorRange = {
     start: number;
     end: number;
@@ -584,7 +607,9 @@ declare interface MetricField extends Field {
      }
      }
      */
-    parameters?: Record<string, any>;
+    parameters?: {
+        filters?: FilterGroup;
+    };
     aliasTemplate?: string;
     valueAliases?: Record<string, string>;
 }
@@ -806,6 +831,10 @@ export declare type TCardPreferences = {
     datasetOptions?: TDatasetOptions[];
     chartOptions?: TChartOptions;
     columnSettings?: TColumnSetting<DisplayDataType>[];
+    colorConfig?: ColorConfig;
+    xAxisConfig?: AxisConfig;
+    yAxisConfig?: AxisConfig;
+    dataLabelsConfig?: TDataLabelsConfig;
     tablePrefs?: TablePreferences;
     allowDownload?: boolean;
     customVisualCode?: string;
@@ -825,6 +854,27 @@ export declare type TCardPreferences = {
     kpiVisualOptions?: {
         lowerIsBetter?: boolean;
         countryLogoId?: string;
+        formatOptions?: TFormatOptions;
+        metricComparison?: {
+            enabled?: boolean;
+            calculationType?: 'difference' | 'change' | 'change_difference' | 'ratio';
+            formatOptions?: TFormatOptions;
+            showArrow?: boolean;
+            showColor?: boolean;
+            conditionalLabel?: boolean;
+            labelName?: string;
+            position?: 'left' | 'right' | 'top';
+            conditionalLabels?: {
+                increase?: string;
+                decrease?: string;
+                noChange?: string;
+            };
+            colorConfig?: {
+                increase?: 'green' | 'red' | 'neutral' | string;
+                decrease?: 'green' | 'red' | 'neutral' | string;
+                noChange?: 'green' | 'red' | 'neutral' | string;
+            };
+        };
     };
     pivotTableOptions?: {
         showRowTotals?: boolean;
@@ -925,6 +975,25 @@ export declare type TDataColumn = {
     description?: string;
 };
 
+export declare type TDataLabelsConfig = {
+    enabled?: boolean;
+    position?: 'center' | 'top' | 'bottom' | 'left' | 'right' | 'auto' | 'custom';
+    anchor?: 'center' | 'start' | 'end';
+    align?: 'center' | 'start' | 'end' | 'top' | 'bottom' | number;
+    display?: 'auto' | boolean;
+    format?: 'auto' | 'number' | 'currency' | 'percent' | 'none';
+    formatOptions?: TFormatOptions;
+    font?: {
+        size?: number;
+        weight?: 'normal' | 'bold';
+    };
+    color?: 'auto' | string;
+    clamp?: boolean;
+    clip?: boolean;
+    rotation?: number;
+    showTotal?: boolean;
+};
+
 export declare type TDatasetOptions = {
     idx: number;
     type?: 'bar' | 'line';
@@ -967,6 +1036,19 @@ declare type TFilter = {
 
 declare type TFilterValue = FilterForString | FilterForEqual | FilterForCompare | FilterForBetween | FilterForIn | FilterForDate;
 
+export declare type TFormatOptions = {
+    type?: 'auto' | 'number' | 'currency' | 'percent' | 'scientific' | 'date';
+    decimalPlaces?: number;
+    currency?: string;
+    locale?: string;
+    prefix?: string;
+    suffix?: string;
+    useSuffix?: boolean;
+    negativeInParentheses?: boolean;
+    multiplyBy?: number;
+    dateFormat?: string;
+};
+
 export declare type TFrame = {
     id: string;
     filterId?: string;

package/package.json

@@ -5,7 +5,7 @@
     "email": "support@semaphor.cloud"
   },
   "license": "MIT",
-  "version": "0.0.115",
+  "version": "0.0.117",
   "description": "Fully interactive and customizable dashboards for your apps.",
   "keywords": [
     "react",