@vizzly/services 0.12.12 → 0.12.13

package/dist/shared-logic/src/AdditionalFilter/AdditionalFilter.d.ts

@@ -1,5 +1,5 @@
 import { DataType } from '../Field/types';
-import { AdditionalFilter, TimeRangeOptions, FilterConfig, OptionalFilters, DateFilter, DateAndTimeFilter, Field } from './types';
+import { AdditionalFilter, TimeRangeOptions, FilterConfig, OptionalFilters, DateFilter, DateAndTimeFilter, LegacyNumericFilterValue, Field } from './types';
 import { DataSet } from '../DataSet/types';
 import * as Filter from '../Filter';
 import { DateTimeFilterOptions } from '../DateTime/types';
@@ -25,6 +25,14 @@ export declare const findMatchingFilter: (dashboardFilters: AdditionalFilter[],
 export declare const removeFilters: <T extends AdditionalFilter>(allFilters: T[], filtersToRemove: T[]) => T[];
 export declare const containsDuplicateFilters: (additionalFilters: Array<AdditionalFilter>) => boolean;
 export declare const removeDeadFields: (filters: Array<AdditionalFilter>, dataSets: DataSet[]) => ({} & AdditionalFilter)[];
+export declare const upcastFilterValue: (value: AdditionalFilter['value'], type: AdditionalFilter['type'], appliesToFields: Field[]) => string | number | boolean | string[] | QueryAttributes.Filter[][] | number[] | LegacyNumericFilterValue | {
+    type: "fixedRange";
+    before: Date | null;
+    after: Date | null;
+} | {
+    type: "relative";
+    value: string;
+} | import("./types").RelativeRangeValue | null;
 export declare enum DateOp {
     Greater = 0,
     Less = 1
@@ -33,3 +41,4 @@ export declare function inclusiveExclusiveCurrent(op: DateOp, filter: DateFilter
 export declare function getCascadeOptionsFilters(globalFilters: AdditionalFilter[], dataSets: DataSet[], dateFilterOptions: DateTimeFilterOptions, cascadeFilterSelection?: boolean): OptionalFilters | undefined;
 export declare const updateFilterForOptionalPulledFromOptions: (filter: AdditionalFilter) => AdditionalFilter;
 export declare const buildAdvancedFilters: (filterValue: QueryAttributes.Filter[][], field: Field, dataSetId: string) => never[] | QueryAttributes.Filter;
+export declare function getFilterDataType(filter: AdditionalFilter, dataSets: DataSet[]): "string" | "number" | "boolean" | "date_time" | "string[]" | undefined;

package/dist/shared-logic/src/AdditionalFilter/constants.d.ts

@@ -5,5 +5,12 @@ export declare const DATE_FILTER = "dateFilter";
 export declare const DATE_TIME_FILTER = "dateTimeFilter";
 export declare const DATE_AND_TIME_FILTER = "dateAndTimeFilter";
 export declare const SINGLE_SELECT_FILTER = "singleSelectFilter";
+/**
+ * @deprecated The "multiSelectFilter" has been deprecated. Use "advancedFilter".
+ */
 export declare const MULTI_SELECT_FILTER = "multiSelectFilter";
+/**
+ * @deprecated The "numericFilter" has been deprecated. Use "advancedFilter".
+ */
 export declare const NUMERIC_FILTER = "numericFilter";
+export declare const ADVANCED_FILTER = "advancedFilter";

package/dist/shared-logic/src/AdditionalFilter/types.d.ts

@@ -4,18 +4,21 @@ export declare type FilterConfig = {
     localFilters?: Array<AdditionalFilter>;
     globalFilters?: Array<AdditionalFilter>;
 };
-export declare type AdditionalFilter = NumericFilter | SingleSelectFilter | DateFilter | DateAndTimeFilter | DateTimeFilter | MultiSelectFilter;
+export declare type AdditionalFilter = NumericFilter | SingleSelectFilter | DateFilter | DateAndTimeFilter | DateTimeFilter | MultiSelectFilter | AdvancedFilter;
 export declare type Field = {
     dataSetId: string;
     fieldId: QueryAttributes.Field;
 };
-declare type AdditionalFilterType = typeof FilterType.DATE_FILTER | typeof FilterType.DATE_TIME_FILTER | typeof FilterType.DATE_AND_TIME_FILTER | typeof FilterType.SINGLE_SELECT_FILTER | typeof FilterType.MULTI_SELECT_FILTER | typeof FilterType.NUMERIC_FILTER;
+declare type AdditionalFilterType = typeof FilterType.DATE_FILTER | typeof FilterType.DATE_TIME_FILTER | typeof FilterType.DATE_AND_TIME_FILTER | typeof FilterType.SINGLE_SELECT_FILTER | typeof FilterType.MULTI_SELECT_FILTER | typeof FilterType.NUMERIC_FILTER | typeof FilterType.ADVANCED_FILTER;
 export declare type OptionalFilters = {
     [dataSetId: string]: Array<QueryAttributes.Filter>;
 };
 declare type BaseAdditionalFilter<T extends AdditionalFilterType> = {
     /**
-     * NOTE: The "dateTimeFilter" type value has been deprecated. Use "dateFilter".
+     * NOTE:
+     * - The "dateTimeFilter" type value has been deprecated. Use "dateFilter".
+     * - The "multiSelectFilter" type value has been deprecated. Use "advancedFilter".
+     * - The "numericFilter" type value has been deprecated. Use "advancedFilter".
      */
     type: T;
     appliesToFields: Array<Field>;
@@ -80,6 +83,10 @@ export declare type MultiSelectFilter = BaseAdditionalFilter<typeof FilterType.M
     value: string[] | number[] | null | QueryAttributes.Filter[][];
     optionsPulledFrom?: Array<Field>;
 };
+export declare type AdvancedFilter = BaseAdditionalFilter<typeof FilterType.ADVANCED_FILTER> & {
+    value: QueryAttributes.Filter[][] | null;
+    optionsPulledFrom?: Array<Field>;
+};
 export declare type TimeRangeOptions = {
     [id: string]: {
         range: {

package/dist/shared-logic/src/Component/types.d.ts

@@ -156,6 +156,7 @@ export declare namespace Component {
         conditionalFormattingRules: Array<ConditionalFormatting.Rule>;
         labelsAsPercentage: boolean;
         legend: boolean;
+        labels?: boolean;
         labelFormat: FormatType;
         parameters?: Parameters;
     };

package/dist/shared-logic/src/ComponentInterface/types/namespaces.types.d.ts

@@ -85,6 +85,7 @@ export interface FormatPanelNamespaces {
         subSectionDefinition: {
             stacked?: SubSection<'stacked'>;
             legend?: SubSection<'legend'>;
+            labels?: SubSection<'labels'>;
             curve?: SubSection<'curve'>;
             number_format?: SubSection<'numberFormat'>;
         };

package/dist/shared-logic/src/Field/types.d.ts

@@ -1,6 +1,6 @@
 import { QueryAttributes } from '../QueryAttributes/types';
 export declare type DataType = 'number' | 'boolean' | 'string' | 'date_time' | 'string[]';
-export declare type DateTimeFormat = 'DD/MM/YYYY' | 'MM/DD/YYYY' | 'DD-MM-YYYY' | 'MM-DD-YYYY' | 'DD MMMM YYYY, hh:mm' | 'dddd DD MMMM YYYY, hh:mm' | 'hh:mm' | 'hh:mm:ss' | 'DD MMMM YYYY' | 'MMMM YYYY' | 'YYYY' | 'YYYY-MM-DD[T]HH:mm:ss' | 'quarter' | 'week';
+export declare type DateTimeFormat = 'DD/MM/YYYY' | 'MM/DD/YYYY' | 'DD-MM-YYYY' | 'MM-DD-YYYY' | 'DD MMMM YYYY, hh:mm' | 'dddd DD MMMM YYYY, hh:mm' | 'hh:mm' | 'hh:mm:ss' | 'DD MMMM YYYY' | 'MMMM YYYY' | 'YYYY' | 'YYYY-MM-DD[T]HH:mm:ss' | 'quarter' | 'week' | 'day_of_month' | 'day_of_week_iso' | 'week_of_year' | 'hour_of_day';
 export declare type SupportedAggregateOption = string;
 declare type DashboardRequiredFilterGroup = {
     /** This is displayed on the global filter, and it is also used to group related filters */

package/dist/shared-logic/src/FormatPanelConfig/types.d.ts

@@ -8,7 +8,7 @@ export declare type FormatSubSections = Section<'time'> | Section<'fontSize'>;
 export declare type FormatSection = Section<'format'> & {
     subSection: Array<FormatSubSections>;
 };
-export declare type ChartStylesSubSections = Section<'stacked' | 'curve' | 'legend' | 'numberFormat'>;
+export declare type ChartStylesSubSections = Section<'stacked' | 'curve' | 'legend' | 'numberFormat' | 'labels'>;
 export declare type ChartStylesSection = Section<'chartStyles'> & {
     subSection: Array<ChartStylesSubSections>;
 };

package/dist/shared-logic/src/Theme/types.d.ts

@@ -15,37 +15,38 @@ export declare type Theme = {
 };
 export declare namespace VizzlyTheming {
     interface Base extends Theme {
+        accordion?: Accordion;
+        ai?: AI;
+        alerts?: Alerts;
         baseFont?: FontStyle;
-        titles?: FontStyle;
         buttons?: Buttons;
-        panels?: Panel;
-        forms?: Form;
-        modals?: Modal;
-        lists?: List;
-        tabs?: Tabs;
-        alerts?: Alerts;
         charts?: Charts;
-        dropdowns?: Dropdown;
-        popoverMenu?: PopoverMenu;
-        tables?: Tables;
-        accordion?: Accordion;
-        radioGroup?: RadioGroup;
-        search?: Search;
         dashboard?: Dashboard;
-        library?: Library;
+        dropdowns?: Dropdown;
+        editor?: {
+            settings?: Panel;
+            component?: Panel;
+            gap?: CSSProperties['gap'];
+        };
         filters?: Filters;
+        forms?: Form;
         header?: Header;
-        ai?: AI;
         icons?: Icons;
+        library?: Library;
+        lists?: List;
+        modals?: Modal;
+        panels?: Panel;
+        popoverMenu?: PopoverMenu;
+        radioGroup?: RadioGroup;
+        search?: Search;
         section?: {
             panel?: Panel;
             title?: FontStyle;
         };
-        editor?: {
-            settings?: Panel;
-            component?: Panel;
-            gap?: CSSProperties['gap'];
-        };
+        tables?: Tables;
+        tabs?: Tabs;
+        titles?: FontStyle;
+        tooltips?: Tooltip;
     }
     interface Buttons {
         primary?: ButtonType;
@@ -345,7 +346,18 @@ export declare namespace VizzlyTheming {
         barChart?: BarChart;
         singleStat?: SingleStat;
         threshold?: ChartThreshold;
+        popoverMenus?: ChartPopoverMenu;
     };
+    interface ChartPopoverMenu {
+        background?: CSSProperties['background'];
+        border?: CSSProperties['border'];
+        borderRadius?: CSSProperties['borderRadius'];
+        boxShadow?: CSSProperties['boxShadow'];
+        color?: CSSProperties['color'];
+        fontFamily?: CSSProperties['fontFamily'];
+        letterSpacing?: CSSProperties['letterSpacing'];
+        padding?: CSSProperties['padding'];
+    }
     type ChartThreshold = {
         stroke: CSSProperties['stroke'];
     };
@@ -564,5 +576,17 @@ export declare namespace VizzlyTheming {
     type SingleStat = {
         delteStyle?: 'pill' | 'text';
     };
+    type Tooltip = {
+        background?: CSSProperties['background'];
+        borderRadius?: CSSProperties['borderRadius'];
+        boxShadow?: CSSProperties['boxShadow'];
+        color?: CSSProperties['color'];
+        fontFamily?: CSSProperties['fontFamily'];
+        fontSize?: CSSProperties['fontSize'];
+        fontWeight?: CSSProperties['fontWeight'];
+        letterSpacing?: CSSProperties['letterSpacing'];
+        lineHeight?: CSSProperties['lineHeight'];
+        padding?: CSSProperties['padding'];
+    };
 }
 export declare type ThemeVersion = 1 | 2;

package/dist/shared-logic/src/utils/DateTime.d.ts

@@ -7,7 +7,8 @@ export declare const formatLongDateAndTime: (date: Date | null) => string | null
 export declare const formatShortDateAndTime: (date: Date | null) => string | null;
 export declare const addMinutes: (date: Date, minutes: number) => Date;
 export declare const isDateBetween: (now: Date, before: Date, after: Date) => boolean;
-export declare const format: (date: Date, format: DateTimeFormat) => string | null;
+export declare const format: (value: Date | string | number, format: DateTimeFormat) => string | null;
+export declare const _formatDate: (date: Date, format: DateTimeFormat) => string | null;
 export declare const fillTruncatedDatesBetween: (start: Date, end: Date, interval: QueryAttributes.TimeDimension.Truncate) => Date[];
 export declare const truncateDateTime: (dateTime: Date, truncate: QueryAttributes.TimeDimension.Truncate) => Date;
 export declare const subtractDays: (date: Date, days: number) => Date;

package/dist/shared-logic/src/utils/numberHelpers.d.ts

@@ -6,3 +6,4 @@ export declare const toDp: (number: number, decimalPlaces: number) => string;
 export declare const toCurrency: (number: number, currency: 'EUR' | 'GBP' | 'USD') => string;
 export declare const toPercentage: (number: number, decimalPlaces?: number) => string;
 export declare function formatCompactNumber(number: number): string;
+export declare const numberPostfix: (number: number) => "th" | "st" | "nd" | "rd";

package/package.json

@@ -26,7 +26,7 @@
     "fix-type-alias": "tsc-alias -p tsconfig.json",
     "prepare": "yarn build"
   },
-  "version": "0.12.12",
+  "version": "0.12.13",
   "dependencies": {
     "@vizzly/api-client": "0.0.38",
     "@vizzly/joi": "^17.11.0",

package/dist/shared-logic/src/ProtectedFields/upcastProtectedFields.d.ts

@@ -1,2 +0,0 @@
-import { Component } from '../Component/types';
-export declare const upcastProtectedFields: (protectedFields: Component.ProtectedFields | undefined) => Component.ProtectedFields | undefined;