@xh/hoist 55.0.8 → 55.2.0

package/CHANGELOG.md

@@ -1,6 +1,24 @@
 # Changelog
 
-## v55.0.0 - 2023-02-08
+## v55.2.0 - 2023-02-10
+
+### 🎁 New Features
+* `DashCanvas` enhancements:
+    * Views now support minimum and maximum dimensions.
+    * Views now expose an `allowDuplicate` flag for controlling the `Duplicate` menu item visibility.
+
+### 🐞 Bug Fixes
+* Fixed a bug with Cube views having dimensions containing non-string or `null` values.  Rows grouped
+by these dimensions would report values for the dimension which were incorrectly stringified (e.g.
+`null` vs. `'null'` or `'5'` vs. `5`).  This has been fixed.  Note that the stringified value is
+still reported for the rows' `cubeLabel` value, and will be used for the purposes of grouping.
+
+### ⚙️ Typescript API Adjustments
+
+* Improved signatures of `RestStore` APIs.
+
+
+## v55.1.0 - 2023-02-09
 
 Version 55 is the first major update of the toolkit after our transition to typescript.  In addition
 to a host of runtime fixes and features, it also contains a good number of important typescript

package/admin/columns/Tracking.ts

@@ -8,7 +8,6 @@ import {RangeAggregator} from '@xh/hoist/admin/tabs/activity/aggregators/RangeAg
 import {Icon} from '@xh/hoist/icon';
 import {fmtDate, fmtSpan, numberRenderer} from '@xh/hoist/format';
 import * as Col from '@xh/hoist/cmp/grid/columns';
-import {isFinite} from 'lodash';
 import {ColumnSpec} from '@xh/hoist/cmp/grid/columns';
 
 export const appEnvironment: ColumnSpec = {
@@ -56,8 +55,7 @@ export const day: ColumnSpec = {
     field: {
         name: 'day',
         type: 'localDate',
-        isDimension: true,
-        aggregator: new RangeAggregator()
+        isDimension: true
     },
     ...Col.localDate,
     displayName: 'App Day'
@@ -178,25 +176,25 @@ export const userMessageFlag: ColumnSpec = {
     }
 };
 
-export const dateRange: ColumnSpec = {
+export const dayRange: ColumnSpec = {
     field: {
-        name: 'day',
+        name: 'dayRange',
         type: 'json',
-        displayName: 'App Day'
+        aggregator: new RangeAggregator(),
+        displayName: 'App Day Range'
     },
-    ...Col.localDate,
+    align: 'right',
     width: 200,
-    renderer: dateRangeRenderer,
-    exportValue: dateRangeRenderer,
-    comparator: dateRangeComparator
+    renderer: dayRangeRenderer,
+    exportValue: dayRangeRenderer,
+    comparator: dayRangeComparator
 };
 
 //-----------------------
 // Implementation
 //-----------------------
-function dateRangeRenderer(range) {
-    if (!range) return;
-    if (isFinite(range)) return fmtDate(range);
+function dayRangeRenderer(range) {
+    if (!range) return null;
 
     const {min, max} = range,
         minStr = fmtDate(min),
@@ -206,7 +204,7 @@ function dateRangeRenderer(range) {
     return `${minStr} → ${maxStr}`;
 }
 
-function dateRangeComparator(rangeA, rangeB, sortDir, abs, {defaultComparator}) {
+function dayRangeComparator(rangeA, rangeB, sortDir, abs, {defaultComparator}) {
     const maxA = rangeA?.max,
         maxB = rangeB?.max;
 

package/admin/tabs/activity/aggregators/RangeAggregator.ts

@@ -11,8 +11,8 @@ import {min, max} from 'lodash';
 export class RangeAggregator extends Aggregator {
 
     override aggregate(rows, fieldName) {
-        const minVals = rows.map(row => row.isLeaf ? row.data[fieldName] : row.data[fieldName].min),
-            maxVals = rows.map(row => row.isLeaf ? row.data[fieldName] : row.data[fieldName].max);
+        const minVals = rows.map(row => row.data[fieldName].min),
+            maxVals = rows.map(row => row.data[fieldName].max);
 
         return {min: min(minVals), max: max(maxVals)};
     }
@@ -26,9 +26,8 @@ export class RangeAggregator extends Aggregator {
 
         if (newValue == null) return currAgg;
 
-        const valFromLeaf = rows[0].isLeaf,
-            minToCheck = valFromLeaf ? newValue : newValue.min,
-            maxToCheck = valFromLeaf ? newValue : newValue.max,
+        const minToCheck = newValue.min,
+            maxToCheck = newValue.max,
             newAgg = {...currAgg};
 
         if (minToCheck < currAgg.min) newAgg.min = minToCheck;

package/admin/tabs/activity/clienterrors/ClientErrorsModel.ts

@@ -16,7 +16,7 @@ import moment from 'moment';
 
 export class ClientErrorsModel extends HoistModel {
 
-    persistWith = {localStorageKey: 'xhAdminClientErrorsState'};
+    override persistWith = {localStorageKey: 'xhAdminClientErrorsState'};
 
     @bindable.ref startDay: LocalDate;
     @bindable.ref endDay: LocalDate;

package/admin/tabs/activity/tracking/ActivityTrackingModel.ts

@@ -21,7 +21,7 @@ export const PERSIST_ACTIVITY = {localStorageKey: 'xhAdminActivityState'};
 
 export class ActivityTrackingModel extends HoistModel {
 
-    persistWith = PERSIST_ACTIVITY;
+    override persistWith = PERSIST_ACTIVITY;
 
     @managed formModel: FormModel;
     @managed groupingChooserModel: GroupingChooserModel;
@@ -66,21 +66,22 @@ export class ActivityTrackingModel extends HoistModel {
 
         this.cube = new Cube({
             fields: [
-                Col.browser.field as CubeFieldSpec,
-                Col.category.field as CubeFieldSpec,
-                Col.data.field as CubeFieldSpec,
+                Col.browser.field,
+                Col.category.field,
+                Col.data.field,
                 {...Col.dateCreated.field as FieldSpec, displayName: 'Timestamp'},
-                Col.day.field as CubeFieldSpec,
-                Col.device.field as CubeFieldSpec,
-                Col.elapsed.field as CubeFieldSpec,
-                Col.entryCount.field as CubeFieldSpec,
-                Col.impersonating.field as CubeFieldSpec,
-                Col.msg.field as CubeFieldSpec,
-                Col.userAgent.field as CubeFieldSpec,
-                Col.username.field as CubeFieldSpec,
+                Col.day.field,
+                Col.dayRange.field,
+                Col.device.field,
+                Col.elapsed.field,
+                Col.entryCount.field,
+                Col.impersonating.field,
+                Col.msg.field,
+                Col.userAgent.field,
+                Col.username.field,
                 {name: 'count', type: 'int', aggregator: 'CHILD_COUNT'},
                 {name: 'month', type: 'string', isDimension: true, aggregator: 'UNIQUE'}
-            ]
+            ] as CubeFieldSpec[]
         });
 
         this.groupingChooserModel = new GroupingChooserModel({
@@ -162,7 +163,7 @@ export class ActivityTrackingModel extends HoistModel {
                 {...Col.userAgent, hidden},
                 {...Col.impersonating, hidden},
                 {...Col.elapsed, headerName: 'Elapsed (avg)', hidden},
-                {...Col.dateRange, hidden},
+                {...Col.dayRange, hidden},
                 {...Col.entryCount},
                 {field: 'count', hidden}
             ]
@@ -203,6 +204,7 @@ export class ActivityTrackingModel extends HoistModel {
             data.forEach(it => {
                 it.day = LocalDate.from(it.day);
                 it.month = it.day.format(this._monthFormat);
+                it.dayRange = {min: it.day, max: it.day};
             });
 
             await cube.loadDataAsync(data);
@@ -291,8 +293,8 @@ export class ActivityTrackingModel extends HoistModel {
         if (rawVal == null) return null;
 
         switch (dim) {
-            // Days are min/max ranges of LocalDates - sort by max date, desc.
-            case 'day': return rawVal.max.timestamp * -1;
+            // Sort date desc by default
+            case 'day': return rawVal.timestamp * -1;
             // Months are formatted "June 2020" strings - sort desc.
             case 'month': return moment(rawVal, this._monthFormat).valueOf() * -1;
             // Everything else can sort with its natural value.

package/admin/tabs/general/config/ConfigPanelModel.ts

@@ -24,7 +24,7 @@ import {FieldSpec} from '@xh/hoist/data';
 
 export class ConfigPanelModel extends HoistModel {
 
-    persistWith = {localStorageKey: 'xhAdminConfigState'};
+    override persistWith = {localStorageKey: 'xhAdminConfigState'};
 
     @managed
     regroupDialogModel = new RegroupDialogModel(this);

package/admin/tabs/general/users/UserModel.ts

@@ -12,7 +12,7 @@ import {keyBy, keys} from 'lodash';
 
 export class UserModel extends HoistModel {
 
-    persistWith = {localStorageKey: 'xhAdminUserState'};
+    override persistWith = {localStorageKey: 'xhAdminUserState'};
 
     @bindable activeOnly = true;
     @bindable withRolesOnly = false;

package/admin/tabs/server/ehcache/EhCacheModel.ts

@@ -12,7 +12,7 @@ import {trimEnd} from 'lodash';
 
 export class EhCacheModel extends HoistModel {
 
-    persistWith = {localStorageKey: 'xhAdminEhCacheState'};
+    override persistWith = {localStorageKey: 'xhAdminEhCacheState'};
 
     @managed
     gridModel = new GridModel({

package/admin/tabs/server/logViewer/LogDisplayModel.ts

@@ -19,7 +19,7 @@ import {LogViewerModel} from './LogViewerModel';
  */
 export class LogDisplayModel extends HoistModel {
 
-    persistWith = {localStorageKey: 'xhAdminLogViewerState'};
+    override persistWith = {localStorageKey: 'xhAdminLogViewerState'};
 
     parent: LogViewerModel;
 

package/admin/tabs/userData/JsonBlobModel.ts

@@ -21,7 +21,7 @@ import {FieldSpec} from '@xh/hoist/data';
 
 export class JsonBlobModel extends HoistModel {
 
-    persistWith = {localStorageKey: 'xhAdminJsonBlobState'};
+    override persistWith = {localStorageKey: 'xhAdminJsonBlobState'};
 
     @managed
     gridModel: RestGridModel;

package/admin/tabs/userData/PreferenceModel.ts

@@ -22,7 +22,7 @@ import {FieldSpec} from '@xh/hoist/data';
 
 export class PreferenceModel extends HoistModel {
 
-    persistWith = {localStorageKey: 'xhAdminPreferenceState'};
+    override persistWith = {localStorageKey: 'xhAdminPreferenceState'};
 
     @managed
     regroupDialogModel = new RegroupDialogModel(this);

package/appcontainer/AboutDialogModel.ts

@@ -15,7 +15,7 @@ import {isNull} from 'lodash';
  * @internal
  */
 export class AboutDialogModel extends HoistModel {
-    xhImpl = true;
+    override xhImpl = true;
 
     @observable
     isOpen: boolean = false;

package/appcontainer/BannerModel.ts

@@ -11,7 +11,7 @@ import {BannerSpec, HoistModel} from '@xh/hoist/core';
  * @internal
  */
 export class BannerModel extends HoistModel {
-    xhImpl = true;
+    override xhImpl = true;
 
     // Immutable public properties
     category;

package/appcontainer/BannerSourceModel.ts

@@ -16,7 +16,7 @@ import {BannerModel} from './BannerModel';
  * @internal
  */
 export class BannerSourceModel extends HoistModel {
-    xhImpl = true;
+    override xhImpl = true;
 
     @managed
     @observable.ref

package/appcontainer/ChangelogDialogModel.ts

@@ -9,7 +9,7 @@ import {action, observable, makeObservable} from '@xh/hoist/mobx';
 import {throwIf} from '@xh/hoist/utils/js';
 
 export class ChangelogDialogModel extends HoistModel {
-    xhImpl = true;
+    override xhImpl = true;
 
     @observable isOpen: boolean = false;
 

package/appcontainer/ErrorBoundary.ts

@@ -20,12 +20,12 @@ export class ErrorBoundary extends Component {
         this.state = {caughtError: null, onError: props.onError};
     }
 
-    render() {
+    override render() {
         // @ts-ignore
         return this.state.caughtError ? 'An error occurred while rendering this Component.' : this.props.children ?? null;
     }
 
-    componentDidCatch(e, info) {
+    override componentDidCatch(e, info) {
         XH.handleException(e, {requireReload: true});
     }
 

package/appcontainer/ExceptionDialogModel.ts

@@ -16,7 +16,7 @@ import {action, observable, makeObservable, bindable} from '@xh/hoist/mobx';
  * @internal
  */
 export class ExceptionDialogModel extends HoistModel {
-    xhImpl = true;
+    override xhImpl = true;
 
     @observable.ref
     displayData: {exception: any, options: any};

package/appcontainer/FeedbackDialogModel.ts

@@ -13,7 +13,7 @@ import {stripTags} from '@xh/hoist/utils/js';
  * @internal
  */
 export class FeedbackDialogModel extends HoistModel {
-    xhImpl = true;
+    override xhImpl = true;
 
     @observable isOpen: boolean = false;
     @observable message: string = null;

package/appcontainer/ImpersonationBarModel.ts

@@ -12,7 +12,7 @@ import {throwIf} from '@xh/hoist/utils/js';
  *  @internal
  */
 export class ImpersonationBarModel extends HoistModel {
-    xhImpl = true;
+    override xhImpl = true;
 
     @observable showRequested: boolean = false;
     @observable.ref targets: string[] = [];

package/appcontainer/MessageModel.ts

@@ -17,7 +17,7 @@ import {isEmpty} from 'lodash';
  * @internal
  */
 export class MessageModel extends HoistModel {
-    xhImpl = true;
+    override xhImpl = true;
 
     // Immutable properties
     title;
@@ -132,7 +132,7 @@ export class MessageModel extends HoistModel {
     //-----------------------
     // Implementation
     //-----------------------
-    destroy() {
+    override destroy() {
         this.close();
         super.destroy();
     }

package/appcontainer/MessageSourceModel.ts

@@ -16,7 +16,7 @@ import {MessageModel} from './MessageModel';
  * @internal
  */
 export class MessageSourceModel extends HoistModel {
-    xhImpl = true;
+    override xhImpl = true;
 
     @managed
     @observable.ref

package/appcontainer/OptionsDialogModel.ts

@@ -17,7 +17,7 @@ import {AppOption} from './AppOption';
  * @internal
  */
 export class OptionsDialogModel extends HoistModel {
-    xhImpl = true;
+    override xhImpl = true;
 
     @observable isOpen = false;
     @observable.ref options = [];

package/appcontainer/SizingModeModel.ts

@@ -13,7 +13,7 @@ import {values, isPlainObject} from 'lodash';
  * @internal
  */
 export class SizingModeModel extends HoistModel {
-    xhImpl = true;
+    override xhImpl = true;
 
     @observable
     sizingMode: SizingMode = null;

package/appcontainer/ThemeModel.ts

@@ -11,7 +11,7 @@ import {action, observable, makeObservable} from '@xh/hoist/mobx';
  * @internal
  */
 export class ThemeModel extends HoistModel {
-    xhImpl = true;
+    override xhImpl = true;
 
     @observable
     darkTheme: boolean;

package/appcontainer/ToastModel.ts

@@ -20,7 +20,7 @@ import {ReactNode, ReactElement} from 'react';
  * will have no effect.
  */
 export class ToastModel extends HoistModel {
-    xhImpl = true;
+    override xhImpl = true;
 
     message: ReactNode;
     icon: ReactElement;
@@ -58,7 +58,7 @@ export class ToastModel extends HoistModel {
         this.isOpen = false;
     }
 
-    destroy() {
+    override destroy() {
         this.dismiss();
         super.destroy();
     }

package/appcontainer/ToastSourceModel.ts

@@ -14,7 +14,7 @@ import {ToastModel} from './ToastModel';
  *  @internal
  */
 export class ToastSourceModel extends HoistModel {
-    xhImpl = true;
+    override xhImpl = true;
 
     @managed
     @observable.ref

package/appcontainer/ViewportSizeModel.ts

@@ -15,7 +15,7 @@ import {isFinite, isString} from 'lodash';
  * @internal
  */
 export class ViewportSizeModel extends HoistModel {
-    xhImpl = true;
+    override xhImpl = true;
 
     @observable.ref
     size: {width: number, height: number};

package/cmp/ag-grid/AgGrid.ts

@@ -112,7 +112,7 @@ export const [AgGrid, agGrid] = hoistCmp.withFactory<AgGridProps>({
 })(AgGrid);
 
 class AgGridLocalModel extends HoistModel {
-    xhImpl = true;
+    override xhImpl = true;
 
     @lookup(AgGridModel) model: AgGridModel;
 

package/cmp/chart/Chart.ts

@@ -91,7 +91,7 @@ export const [Chart, chart] = hoistCmp.withFactory<ChartProps>({
 
 
 class ChartLocalModel extends HoistModel {
-    xhImpl = true;
+    override xhImpl = true;
 
     @lookup(ChartModel)
     model: ChartModel;
@@ -100,7 +100,7 @@ class ChartLocalModel extends HoistModel {
     contextMenu: any;
     prevSeriesConfig;
 
-    onLinked() {
+    override onLinked() {
         this.contextMenu = this.getContextMenu();
 
         this.addReaction({
@@ -222,7 +222,7 @@ class ChartLocalModel extends HoistModel {
         return {width, height};
     }
 
-    destroy() {
+    override destroy() {
         this.destroyHighChart();
         super.destroy();
     }

package/cmp/clock/Clock.ts

@@ -59,7 +59,7 @@ export const [Clock, clock] = hoistCmp.withFactory<ClockProps>({
 });
 
 class ClockLocalModel extends HoistModel {
-    xhImpl = true;
+    override xhImpl = true;
 
     offset;
     offsetException;
@@ -72,7 +72,7 @@ class ClockLocalModel extends HoistModel {
         makeObservable(this);
     }
 
-    onLinked() {
+    override onLinked() {
         this.addReaction({
             track: () => this.componentProps.timeZone,
             run: () => this.loadTimezoneOffsetAsync(),

package/cmp/dataview/DataView.ts

@@ -39,12 +39,12 @@ export const [DataView, dataView] = hoistCmp.withFactory<DataViewProps>({
 });
 
 class DataViewLocalModel extends HoistModel {
-    xhImpl = true;
+    override xhImpl = true;
 
     @lookup(DataViewModel) model: DataViewModel;
     agOptions: PlainObject;
 
-    onLinked() {
+    override onLinked() {
         const {model} = this;
 
         this.addReaction({

package/cmp/dataview/DataViewModel.ts

@@ -219,7 +219,7 @@ export class DataViewModel extends HoistModel {
         return this.gridModel.ensureSelectionVisibleAsync();
     }
 
-    doLoadAsync(loadSpec: LoadSpec) {
+    override doLoadAsync(loadSpec: LoadSpec) {
         return this.gridModel.doLoadAsync(loadSpec);
     }
 

package/cmp/grid/Grid.ts

@@ -128,7 +128,7 @@ export const [Grid, grid] = hoistCmp.withFactory<GridProps>({
 // Implementation
 //------------------------
 class GridLocalModel extends HoistModel {
-    xhImpl = true;
+    override xhImpl = true;
 
     @lookup(GridModel)
     private model: GridModel;

package/cmp/grid/filter/GridFilterModel.ts

@@ -22,7 +22,7 @@ import {GridModel} from '../GridModel';
  * @internal
  */
 export class GridFilterModel extends HoistModel {
-    xhImpl = true;
+    override xhImpl = true;
 
     gridModel: GridModel;
     bind: Store|View;

package/cmp/grid/impl/ColumnGroupHeader.ts

@@ -55,7 +55,7 @@ export const columnGroupHeader = hoistCmp.factory({
 });
 
 class ColumnGroupHeaderModel extends HoistModel {
-    xhImpl = true;
+    override xhImpl = true;
 
     @bindable isExpanded = true;
 
@@ -72,12 +72,12 @@ class ColumnGroupHeaderModel extends HoistModel {
         makeObservable(this);
     }
 
-    onLinked() {
+    override onLinked() {
         this.syncIsExpanded();
         this.agColumnGroup.addEventListener('expandedChanged', this.syncIsExpanded);
     }
 
-    destroy() {
+    override destroy() {
         this.agColumnGroup.removeEventListener('expandedChanged', this.syncIsExpanded);
         super.destroy();
     }

package/cmp/grid/impl/ColumnHeader.ts

@@ -128,7 +128,7 @@ export const columnHeader = hoistCmp.factory({
 
 
 class ColumnHeaderModel extends HoistModel {
-    xhImpl = true;
+    override xhImpl = true;
 
     get gridModel()     {return this.componentProps.gridModel}
     get xhColumn()      {return this.componentProps.xhColumn}
@@ -157,7 +157,7 @@ class ColumnHeaderModel extends HoistModel {
         makeObservable(this);
     }
 
-    onLinked() {
+    override onLinked() {
         const {xhColumn, agColumn} = this,
             {filterModel} = this.gridModel;
 
@@ -172,7 +172,7 @@ class ColumnHeaderModel extends HoistModel {
         }
     }
 
-    destroy() {
+    override destroy() {
         this.agColumn.removeEventListener('filterChanged', this.onFilterChanged);
         super.destroy();
     }

package/cmp/grid/impl/GridPersistenceModel.ts

@@ -16,7 +16,7 @@ import { GridModelPersistOptions } from '../Types';
  * @internal
  */
 export class GridPersistenceModel extends HoistModel {
-    xhImpl = true;
+    override xhImpl = true;
 
     VERSION = 1;  // Increment to abandon state.
 

package/cmp/input/HoistInputModel.ts

@@ -109,7 +109,7 @@ export class HoistInputModel extends HoistModel {
         makeObservable(this);
     }
 
-    afterLinked() {
+    override afterLinked() {
         this.addReaction(this.externalValueReaction());
     }
 

package/cmp/layout/TileFrame.ts

@@ -111,7 +111,7 @@ export const [TileFrame, tileFrame] = hoistCmp.withFactory({
 });
 
 class TileFrameLocalModel extends HoistModel {
-    xhImpl = true;
+    override xhImpl = true;
 
     params;
     layout;

package/cmp/relativetimestamp/RelativeTimestamp.ts

@@ -87,7 +87,7 @@ export const [RelativeTimestamp, relativeTimestamp] = hoistCmp.withFactory<Relat
 });
 
 class RelativeTimestampLocalModel extends HoistModel {
-    xhImpl = true;
+    override xhImpl = true;
 
     @observable display = '';
     model: HoistModel;

package/cmp/store/impl/StoreFilterFieldImplModel.ts

@@ -26,7 +26,7 @@ import {
  * @internal
  */
 export class StoreFilterFieldImplModel extends HoistModel {
-    xhImpl = true;
+    override xhImpl = true;
 
     @lookup('*') model;
 
@@ -41,7 +41,7 @@ export class StoreFilterFieldImplModel extends HoistModel {
         makeObservable(this);
     }
 
-    onLinked() {
+    override onLinked() {
         let {gridModel, store, includeFields, bind, filterBuffer = 200} = this.componentProps;
 
         throwIf(gridModel && store, "Cannot specify both 'gridModel' and 'store' props.");