@xh/hoist 76.0.0-SNAPSHOT.1755706862648 → 76.0.0-SNAPSHOT.1755780982882

package/CHANGELOG.md

@@ -2,17 +2,24 @@
 
 ## 76.0.0-SNAPSHOT - unreleased
 
+### 💥 Breaking Changes (upgrade difficulty: 🟢 LOW - requires hoist-core v31.2)
+
 ### 🎁 New Features
 
 * Added new `extraConfirmText`, `extraConfirmLabel` properties to `MessageOptions`. Use this option
   to require the specified text to be re-typed by a user when confirming a potentially destructive
   or disruptive action.
+* Updated grid column filters to apply on `Enter` / dismiss on `Esc` and tweaked the filter popup
+  toolbar for clarity.
 
 ### 🐞 Bug Fixes
 
 * Handled an edge-case `ViewManager` bug where `enableDefault` changed to `false` after some user
   state had already been persisted w/users pointed at in-code default view. The manager now calls
   its configured `initialViewSpec` function as expected in this case.
+  
+* `XH.restoreDefaultsAsync` will now clear basic view state.  Views themselves will be preserved.
+  Requires hoist-core v31.2
 
 ### ⚙️ Technical
 

package/build/types/core/HoistAppModel.d.ts

@@ -51,12 +51,15 @@ export declare class HoistAppModel extends HoistModel {
     /**
      * Resets user preferences and any persistent local application state.
      *
-     * The default implementation for this method will clear *all* preferences and local storage.
+     * The default implementation for this method will clear all preferences, local storage, and
+     * transient view state such as current, and pinned views.  Views themselves are preserved.
      *
-     * Applications may wish to override this method to do a more targeted clearing of state.
+     * Applications may wish to override this method to perform a more targeted clearing of state.
      * This is important for complex applications with smaller sub-applications, and/or device
      * specific applications. These applications will typically want to perform a custom clearing
      * that is more targeted, and includes any additional app-specific state.
+     *
+     * Not typically called directly by applications.  Call XH.restoreDefaultsAsync() instead.
      */
     restoreDefaultsAsync(): Promise<void>;
 }

package/build/types/core/XH.d.ts

@@ -11,7 +11,7 @@ import { ToastModel } from '../appcontainer/ToastModel';
 import '../styles/XH.scss';
 import { AppSpec, AppState, AppSuspendData, BannerSpec, ExceptionHandler, ExceptionHandlerOptions, HoistAppModel, HoistException, HoistService, HoistServiceClass, HoistUser, MessageSpec, PageState, PlainObject, ReloadAppOptions, SizingMode, TaskObserver, Theme, ToastSpec, TrackOptions } from './';
 import { HoistModel, ModelSelector, RefreshContextModel } from './model';
-export declare const MIN_HOIST_CORE_VERSION = "30.1";
+export declare const MIN_HOIST_CORE_VERSION = "31.2";
 /**
  * Top-level Singleton model for Hoist. This is the main entry point for the API.
  *
@@ -396,7 +396,9 @@ export declare class XHApi {
     /** All Stores registered with this application. */
     getStores(): Store[];
     /**
-     * Reset user preferences and any persistent local application state, then reload the app.
+     * Reset user state and then reload the app.
+     *
+     * @see HoistAppModel.restoreDefaultsAsync()
      */
     restoreDefaultsAsync(): Promise<void>;
     /**

package/build/types/desktop/cmp/grid/impl/filter/headerfilter/HeaderFilterModel.d.ts

@@ -1,6 +1,7 @@
 import { TabContainerModel } from '@xh/hoist/cmp/tab';
 import { HoistModel } from '@xh/hoist/core';
-import { GridFilterFieldSpec } from '@xh/hoist/cmp/grid';
+import { CompoundFilter, FieldFilter, FieldType, Filter, FilterLike, Store } from '@xh/hoist/data';
+import { GridFilterFieldSpec, GridFilterModel } from '@xh/hoist/cmp/grid';
 import { CustomTabModel } from './custom/CustomTabModel';
 import { ValuesTabModel } from './values/ValuesTabModel';
 import { ColumnHeaderFilterModel } from '../ColumnHeaderFilterModel';
@@ -11,15 +12,17 @@ export declare class HeaderFilterModel extends HoistModel {
     tabContainerModel: TabContainerModel;
     valuesTabModel: ValuesTabModel;
     customTabModel: CustomTabModel;
-    get filterModel(): import("@xh/hoist/cmp/grid").GridFilterModel;
+    get filterModel(): GridFilterModel;
     get field(): string;
-    get store(): import("../../../../../../data").Store;
-    get fieldType(): import("../../../../../../data").FieldType;
-    get currentGridFilter(): import("../../../../../../data").Filter;
-    get columnFilters(): import("../../../../../../data").FieldFilter[];
-    get columnCompoundFilter(): import("../../../../../../data").CompoundFilter;
+    get store(): Store;
+    get fieldType(): FieldType;
+    get currentGridFilter(): Filter;
+    get columnFilters(): FieldFilter[];
+    get columnCompoundFilter(): CompoundFilter;
     get hasFilter(): boolean;
+    get pendingFilter(): FilterLike;
     get hasPendingFilter(): boolean;
+    get isDirty(): boolean;
     get isCustomFilter(): boolean;
     get commitOnChange(): boolean;
     onLinked(): void;

package/build/types/svc/PrefService.d.ts

@@ -56,11 +56,6 @@ export declare class PrefService extends HoistService {
      * before making another call that relies on its updated value being read on the server.
      */
     pushAsync(key: string, value: any): Promise<void>;
-    /**
-     * Reset *all* preferences, reverting their effective values back to defaults.
-     * @returns a Promise that resolves when preferences have been cleared and defaults reloaded.
-     */
-    clearAllAsync(): Promise<void>;
     /**
      * Push any pending buffered updates to persist newly set values to server.
      * Called automatically by this app on page unload to avoid dropping changes when e.g. a user

package/core/HoistAppModel.ts

@@ -88,16 +88,22 @@ export class HoistAppModel extends HoistModel {
     /**
      * Resets user preferences and any persistent local application state.
      *
-     * The default implementation for this method will clear *all* preferences and local storage.
+     * The default implementation for this method will clear all preferences, local storage, and
+     * transient view state such as current, and pinned views.  Views themselves are preserved.
      *
-     * Applications may wish to override this method to do a more targeted clearing of state.
+     * Applications may wish to override this method to perform a more targeted clearing of state.
      * This is important for complex applications with smaller sub-applications, and/or device
      * specific applications. These applications will typically want to perform a custom clearing
      * that is more targeted, and includes any additional app-specific state.
+     *
+     * Not typically called directly by applications.  Call XH.restoreDefaultsAsync() instead.
      */
     async restoreDefaultsAsync() {
         const XH = window['XH'];
-        await XH.prefService.clearAllAsync();
+        await XH.fetchJson({
+            url: 'xh/clearUserState',
+            params: {clientUsername: XH.getUsername()}
+        });
         XH.localStorageService.clear();
         XH.sessionStorageService.clear();
     }

package/core/XH.ts

@@ -67,7 +67,7 @@ import {instanceManager} from './impl/InstanceManager';
 import {HoistModel, ModelSelector, RefreshContextModel} from './model';
 import ShortUniqueId from 'short-unique-id';
 
-export const MIN_HOIST_CORE_VERSION = '30.1';
+export const MIN_HOIST_CORE_VERSION = '31.2';
 
 declare const xhAppCode: string;
 declare const xhAppName: string;
@@ -772,11 +772,21 @@ export class XHApi {
     }
 
     /**
-     * Reset user preferences and any persistent local application state, then reload the app.
+     * Reset user state and then reload the app.
+     *
+     * @see HoistAppModel.restoreDefaultsAsync()
      */
     async restoreDefaultsAsync() {
-        await this.appModel.restoreDefaultsAsync();
-        this.reloadApp();
+        try {
+            await this.appModel.restoreDefaultsAsync();
+            XH.trackService.track({category: 'App', message: 'Restored app defaults'});
+            this.reloadApp();
+        } catch (e) {
+            XH.handleException(e, {
+                message: 'Failed to restore app defaults',
+                requireReload: true
+            });
+        }
     }
 
     /**

package/desktop/cmp/grid/impl/filter/headerfilter/HeaderFilter.ts

@@ -12,6 +12,7 @@ import {button, buttonGroup} from '@xh/hoist/desktop/cmp/button';
 import {panel} from '@xh/hoist/desktop/cmp/panel';
 import {toolbar} from '@xh/hoist/desktop/cmp/toolbar';
 import {Icon} from '@xh/hoist/icon';
+import {wait} from '@xh/hoist/promise';
 import {stopPropagation} from '@xh/hoist/utils/js';
 import {HeaderFilterModel} from './HeaderFilterModel';
 
@@ -22,7 +23,7 @@ import {HeaderFilterModel} from './HeaderFilterModel';
  */
 export const headerFilter = hoistCmp.factory({
     model: creates(HeaderFilterModel),
-    render() {
+    render({model}) {
         return panel({
             title: `Filter`,
             className: 'xh-column-header-filter',
@@ -31,31 +32,49 @@ export const headerFilter = hoistCmp.factory({
             onDoubleClick: stopPropagation,
             headerItems: [switcher()],
             item: tabContainer(),
-            bbar: bbar()
+            bbar: bbar(),
+            hotkeys: [
+                {
+                    allowInInput: true,
+                    combo: 'enter',
+                    label: 'Apply',
+                    group: 'Column Filter',
+                    onKeyDown: () =>
+                        // Wait for debounced reaction in `ValuesTabModel` to run before committing
+                        wait(400).then(() => {
+                            if (model.isDirty) model.commit();
+                        })
+                }
+            ]
         });
     }
 });
 
 const bbar = hoistCmp.factory<HeaderFilterModel>({
     render({model}) {
-        const {commitOnChange} = model;
+        const {commitOnChange, hasFilter, isDirty} = model;
         return toolbar({
             compact: true,
             items: [
-                filler(),
                 button({
                     icon: Icon.delete(),
-                    text: 'Clear Filter',
+                    text: 'Clear',
                     intent: 'danger',
-                    disabled: !model.hasFilter,
+                    disabled: !hasFilter,
                     onClick: () => model.clear()
                 }),
+                filler(),
+                button({
+                    omit: commitOnChange,
+                    text: 'Cancel',
+                    onClick: () => model.parent.close()
+                }),
                 button({
                     omit: commitOnChange,
-                    icon: Icon.check(),
-                    text: 'Apply Filter',
-                    intent: 'success',
-                    disabled: !model.hasFilter && !model.hasPendingFilter,
+                    text: 'Apply',
+                    disabled: !isDirty,
+                    intent: 'primary',
+                    minimal: false,
                     onClick: () => model.commit()
                 })
             ]

package/desktop/cmp/grid/impl/filter/headerfilter/HeaderFilterModel.ts

@@ -7,10 +7,19 @@
 
 import {TabContainerModel} from '@xh/hoist/cmp/tab';
 import {HoistModel, managed, lookup} from '@xh/hoist/core';
+import {
+    CompoundFilter,
+    FieldFilter,
+    FieldType,
+    Filter,
+    FilterLike,
+    parseFilter,
+    Store
+} from '@xh/hoist/data';
 import {action, computed} from '@xh/hoist/mobx';
 import {wait} from '@xh/hoist/promise';
 import {isEmpty} from 'lodash';
-import {GridFilterFieldSpec} from '@xh/hoist/cmp/grid';
+import {GridFilterFieldSpec, GridFilterModel} from '@xh/hoist/cmp/grid';
 import {customTab} from './custom/CustomTab';
 import {CustomTabModel} from './custom/CustomTabModel';
 import {valuesTab} from './values/ValuesTab';
@@ -29,43 +38,54 @@ export class HeaderFilterModel extends HoistModel {
     @managed valuesTabModel: ValuesTabModel;
     @managed customTabModel: CustomTabModel;
 
-    get filterModel() {
+    get filterModel(): GridFilterModel {
         return this.parent.filterModel;
     }
 
-    get field() {
+    get field(): string {
         return this.fieldSpec.field;
     }
 
-    get store() {
+    get store(): Store {
         return this.filterModel.gridModel.store;
     }
 
-    get fieldType() {
+    get fieldType(): FieldType {
         return this.store.getField(this.field).type;
     }
 
-    get currentGridFilter() {
+    get currentGridFilter(): Filter {
         return this.filterModel.filter;
     }
 
-    get columnFilters() {
+    get columnFilters(): FieldFilter[] {
         return this.filterModel.getColumnFilters(this.field);
     }
 
-    get columnCompoundFilter() {
+    get columnCompoundFilter(): CompoundFilter {
         return this.filterModel.getColumnCompoundFilter(this.field);
     }
 
-    get hasFilter() {
+    get hasFilter(): boolean {
         return !isEmpty(this.columnFilters);
     }
 
-    get hasPendingFilter() {
+    get pendingFilter(): FilterLike {
         const {activeTabId} = this.tabContainerModel;
         return activeTabId === 'valuesFilter'
-            ? !!this.valuesTabModel.filter
-            : !!this.customTabModel.filter;
+            ? this.valuesTabModel.filter
+            : this.customTabModel.filter;
+    }
+
+    get hasPendingFilter(): boolean {
+        return !!this.pendingFilter;
+    }
+
+    @computed
+    get isDirty(): boolean {
+        const current = parseFilter(this.columnFilters),
+            pending = parseFilter(this.pendingFilter);
+        return current ? !current.equals(pending) : !!pending;
     }
 
     @computed

package/desktop/cmp/grid/impl/filter/headerfilter/values/ValuesTabModel.ts

@@ -96,6 +96,8 @@ export class ValuesTabModel extends HoistModel {
             {
                 track: () => this.filterText,
                 run: () => this.onFilterTextChange(),
+                // Must be longer than the `filterBuffer` on `storeFilterField` since this Grid's
+                // filtered RecordSet must be current before `onFilterTextChange` can run.
                 debounce: 300
             },
             {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xh/hoist",
-  "version": "76.0.0-SNAPSHOT.1755706862648",
+  "version": "76.0.0-SNAPSHOT.1755780982882",
   "description": "Hoist add-on for building and deploying React Applications.",
   "repository": "github:xh/hoist-react",
   "homepage": "https://xh.io",

package/svc/PrefService.ts

@@ -110,18 +110,6 @@ export class PrefService extends HoistService {
         return this.pushPendingAsync();
     }
 
-    /**
-     * Reset *all* preferences, reverting their effective values back to defaults.
-     * @returns a Promise that resolves when preferences have been cleared and defaults reloaded.
-     */
-    async clearAllAsync() {
-        await XH.fetchJson({
-            url: 'xh/clearPrefs',
-            params: {clientUsername: XH.getUsername()}
-        });
-        return this.loadPrefsAsync();
-    }
-
     /**
      * Push any pending buffered updates to persist newly set values to server.
      * Called automatically by this app on page unload to avoid dropping changes when e.g. a user