@xh/hoist 72.0.0 → 72.1.0

package/admin/tabs/userData/prefs/UserPreferencePanel.ts

@@ -4,32 +4,62 @@
  *
  * Copyright © 2025 Extremely Heavy Industries Inc.
  */
+
+import * as Col from '@xh/hoist/admin/columns/Rest';
+import * as AdminCol from '@xh/hoist/admin/columns';
 import {prefEditorDialog} from '@xh/hoist/admin/tabs/userData/prefs/editor/PrefEditorDialog';
 import {UserPreferenceModel} from '@xh/hoist/admin/tabs/userData/prefs/UserPreferenceModel';
+import {hframe} from '@xh/hoist/cmp/layout';
 import {creates, hoistCmp} from '@xh/hoist/core';
 import {button} from '@xh/hoist/desktop/cmp/button';
+import {jsonSearchButton} from '@xh/hoist/admin/jsonsearch/JsonSearch';
 import {panel} from '@xh/hoist/desktop/cmp/panel';
 import {restGrid} from '@xh/hoist/desktop/cmp/rest';
+import {toolbarSep} from '@xh/hoist/desktop/cmp/toolbar';
 import {Icon} from '@xh/hoist/icon';
 
 export const userPreferencePanel = hoistCmp.factory({
     model: creates(UserPreferenceModel),
 
     render({model}) {
-        return panel({
-            items: [
-                restGrid({
-                    extraToolbarItems: () => {
-                        return button({
-                            icon: Icon.gear(),
-                            text: 'Configure',
-                            onClick: () => (model.showEditorDialog = true)
-                        });
-                    }
-                }),
-                prefEditorDialog()
-            ],
-            mask: 'onLoad'
-        });
+        return hframe(
+            panel({
+                items: [
+                    restGrid({
+                        extraToolbarItems: () => [
+                            button({
+                                icon: Icon.gear(),
+                                text: 'Configure',
+                                onClick: () => (model.showEditorDialog = true)
+                            }),
+                            toolbarSep(),
+                            jsonSearchButton({
+                                subjectName: 'User Preference',
+                                docSearchUrl: 'jsonSearch/searchUserPreferences',
+                                gridModelConfig: {
+                                    sortBy: ['groupName', 'name', 'owner'],
+                                    columns: [
+                                        {
+                                            field: {name: 'owner', type: 'string'},
+                                            width: 200
+                                        },
+                                        {...AdminCol.groupName},
+                                        {...AdminCol.name},
+                                        {
+                                            field: {name: 'json', type: 'string'},
+                                            hidden: true
+                                        },
+                                        {...Col.lastUpdated}
+                                    ]
+                                },
+                                groupByOptions: ['owner', 'groupName', 'name']
+                            })
+                        ]
+                    }),
+                    prefEditorDialog()
+                ],
+                mask: 'onLoad'
+            })
+        );
     }
 });

package/admin/tabs/userData/roles/RoleModel.ts

@@ -80,7 +80,7 @@ export class RoleModel extends HoistModel {
             runInAction(() => {
                 this.allRoles = this.processRolesFromServer(data);
             });
-            this.displayRoles();
+            this.displayRoles(loadSpec.isRefresh);
             await this.gridModel.preSelectFirstAsync();
         } catch (e) {
             if (loadSpec.isStale) return;
@@ -212,13 +212,13 @@ export class RoleModel extends HoistModel {
     //------------------
     // Implementation
     //------------------
-    private displayRoles() {
+    private displayRoles(isRefresh?: boolean) {
         const {gridModel} = this,
             gridData = this.showInGroups
                 ? this.processRolesForTreeGrid(this.allRoles)
                 : this.allRoles;
         gridModel.loadData(gridData);
-        gridModel.expandAll();
+        if (!isRefresh) gridModel.expandAll();
         gridModel.autosizeAsync({includeCollapsedChildren: true});
     }
 

package/admin/tabs/userData/roles/editor/form/RoleFormModel.ts

@@ -46,9 +46,9 @@ export class RoleFormModel extends HoistModel {
     @computed
     get hasDirtyMembers(): boolean {
         return (
-            this.usersGridModel.store.isModified ||
-            this.directoryGroupsGridModel.store.isModified ||
-            this.rolesGridModel.store.isModified
+            this.usersGridModel.store.isDirty ||
+            this.directoryGroupsGridModel.store.isDirty ||
+            this.rolesGridModel.store.isDirty
         );
     }
 

package/build/types/admin/jsonsearch/JsonSearch.d.ts

@@ -0,0 +1,17 @@
+import { GridConfig } from '@xh/hoist/cmp/grid';
+import { HoistProps, SelectOption } from '@xh/hoist/core';
+export interface JsonSearchButtonProps extends HoistProps {
+    /** Descriptive label for the type of records being searched - will be auto-pluralized. */
+    subjectName: string;
+    /** Endpoint to search and return matches - Hoist `JsonSearchController` action expected. */
+    docSearchUrl: string;
+    /** Config for GridModel used to display search results. */
+    gridModelConfig: GridConfig;
+    /** Field names on returned results to enable for grouping in the search results grid. */
+    groupByOptions: Array<SelectOption | any>;
+}
+/**
+ * Main entry point component for the JSON search feature. Supported out-of-the-box for a limited
+ * set of Hoist artifacts that hold JSON values: JSONBlob, Configs, and User Preferences.
+ */
+export declare const jsonSearchButton: import("@xh/hoist/core").ElementFactory<JsonSearchButtonProps>;

package/build/types/admin/jsonsearch/impl/JsonSearchImplModel.d.ts

@@ -0,0 +1,32 @@
+import { GridConfig, GridModel } from '@xh/hoist/cmp/grid';
+import { HoistModel, TaskObserver } from '@xh/hoist/core';
+/**
+ * @internal
+ */
+export declare class JsonSearchImplModel extends HoistModel {
+    xhImpl: boolean;
+    private matchingNodesUrl;
+    gridModel: GridModel;
+    docLoadTask: TaskObserver;
+    nodeLoadTask: TaskObserver;
+    groupBy: string;
+    isOpen: boolean;
+    error: any;
+    path: string;
+    readerContentType: 'document' | 'matches';
+    pathFormat: 'XPath' | 'JSONPath';
+    readerContent: string;
+    matchingNodeCount: number;
+    get subjectName(): string;
+    get docSearchUrl(): string;
+    get gridModelConfig(): GridConfig;
+    get selectedRecord(): import("../../../data").StoreRecord;
+    get groupByOptions(): any[];
+    toggleSearchIsOpen(): void;
+    constructor();
+    onLinked(): void;
+    loadMatchingDocsAsync(): Promise<void>;
+    private loadReaderContentAsync;
+    private convertToXPath;
+    private setGroupBy;
+}

package/build/types/core/persist/PersistenceProvider.d.ts

@@ -41,6 +41,10 @@ export declare abstract class PersistenceProvider<S = any> {
      * target without thrashing.
      */
     static create<S>(cfg: PersistenceProviderConfig<S>): PersistenceProvider<S>;
+    /**
+     * Merge PersistOptions, respecting provider types, with later options overriding earlier ones.
+     */
+    static mergePersistOptions(defaults: PersistOptions, ...overrides: PersistOptions[]): PersistOptions;
     /** Read persisted state at this provider's path. */
     read(): PersistableState<S>;
     /** Persist JSON-serializable state to this provider's path. */

package/build/types/data/Store.d.ts

@@ -275,6 +275,8 @@ export declare class Store extends HoistBase {
     /** Records removed locally which have not been committed.*/
     get removedRecords(): StoreRecord[];
     /** Records modified locally since they were last loaded. */
+    get dirtyRecords(): StoreRecord[];
+    /** Alias for {@link Store.dirtyRecords} */
     get modifiedRecords(): StoreRecord[];
     /**
      * Root records in this store, respecting any filter (if applied).
@@ -292,6 +294,8 @@ export declare class Store extends HoistBase {
      */
     get summaryRecord(): StoreRecord;
     /** True if the store has changes which need to be committed. */
+    get isDirty(): boolean;
+    /** Alias for {@link Store.isDirty} */
     get isModified(): boolean;
     /**
      * Set a filter on this store.

package/build/types/data/StoreRecord.d.ts

@@ -51,6 +51,8 @@ export declare class StoreRecord {
     /** True if the StoreRecord has never been committed. */
     get isAdd(): boolean;
     /** True if the StoreRecord has been modified since it was last committed. */
+    get isDirty(): boolean;
+    /** Alias for {@link StoreRecord.isDirty} */
     get isModified(): boolean;
     /** False if the StoreRecord has been added or modified. */
     get isCommitted(): boolean;

package/cmp/filter/FilterChooserModel.ts

@@ -415,7 +415,9 @@ export class FilterChooserModel extends HoistModel {
     }: FilterChooserPersistOptions) {
         if (persistValue) {
             const status = {initialized: false},
-                persistWith = isObject(persistValue) ? persistValue : rootPersistWith;
+                persistWith = isObject(persistValue)
+                    ? PersistenceProvider.mergePersistOptions(rootPersistWith, persistValue)
+                    : rootPersistWith;
             PersistenceProvider.create({
                 persistOptions: {
                     path: `${path}.value`,
@@ -432,7 +434,9 @@ export class FilterChooserModel extends HoistModel {
         }
 
         if (persistFavorites) {
-            const persistWith = isObject(persistFavorites) ? persistFavorites : rootPersistWith,
+            const persistWith = isObject(persistFavorites)
+                    ? PersistenceProvider.mergePersistOptions(rootPersistWith, persistFavorites)
+                    : rootPersistWith,
                 provider = PersistenceProvider.create({
                     persistOptions: {
                         path: `${path}.favorites`,

package/cmp/grid/impl/InitPersist.ts

@@ -24,7 +24,9 @@ export function initPersist(
     }: GridModelPersistOptions
 ) {
     if (persistColumns) {
-        const persistWith = isObject(persistColumns) ? persistColumns : rootPersistWith;
+        const persistWith = isObject(persistColumns)
+            ? PersistenceProvider.mergePersistOptions(rootPersistWith, persistColumns)
+            : rootPersistWith;
         PersistenceProvider.create({
             persistOptions: {
                 path: `${path}.columns`,
@@ -39,7 +41,9 @@ export function initPersist(
     }
 
     if (persistSort) {
-        const persistWith = isObject(persistSort) ? persistSort : rootPersistWith;
+        const persistWith = isObject(persistSort)
+            ? PersistenceProvider.mergePersistOptions(rootPersistWith, persistSort)
+            : rootPersistWith;
         PersistenceProvider.create({
             persistOptions: {
                 path: `${path}.sortBy`,
@@ -55,7 +59,9 @@ export function initPersist(
     }
 
     if (persistGrouping) {
-        const persistWith = isObject(persistSort) ? persistSort : rootPersistWith;
+        const persistWith = isObject(persistGrouping)
+            ? PersistenceProvider.mergePersistOptions(rootPersistWith, persistGrouping)
+            : rootPersistWith;
         PersistenceProvider.create({
             persistOptions: {
                 path: `${path}.groupBy`,

package/cmp/grouping/GroupingChooserModel.ts

@@ -293,7 +293,9 @@ export class GroupingChooserModel extends HoistModel {
         ...rootPersistWith
     }: GroupingChooserPersistOptions) {
         if (persistValue) {
-            const persistWith = isObject(persistValue) ? persistValue : rootPersistWith;
+            const persistWith = isObject(persistValue)
+                ? PersistenceProvider.mergePersistOptions(rootPersistWith, persistValue)
+                : rootPersistWith;
             PersistenceProvider.create({
                 persistOptions: {
                     path: `${path}.value`,
@@ -308,7 +310,9 @@ export class GroupingChooserModel extends HoistModel {
         }
 
         if (persistFavorites) {
-            const persistWith = isObject(persistFavorites) ? persistFavorites : rootPersistWith,
+            const persistWith = isObject(persistFavorites)
+                    ? PersistenceProvider.mergePersistOptions(rootPersistWith, persistFavorites)
+                    : rootPersistWith,
                 provider = PersistenceProvider.create({
                     persistOptions: {
                         path: `${path}.favorites`,

package/cmp/zoneGrid/impl/InitPersist.ts

@@ -24,7 +24,9 @@ export function initPersist(
     }: ZoneGridModelPersistOptions
 ) {
     if (persistMappings) {
-        const persistWith = isObject(persistMappings) ? persistMappings : rootPersistWith;
+        const persistWith = isObject(persistMappings)
+            ? PersistenceProvider.mergePersistOptions(rootPersistWith, persistMappings)
+            : rootPersistWith;
         PersistenceProvider.create({
             persistOptions: {
                 path: `${path}.mappings`,
@@ -39,7 +41,9 @@ export function initPersist(
     }
 
     if (persistGrouping) {
-        const persistWith = isObject(persistGrouping) ? persistGrouping : rootPersistWith;
+        const persistWith = isObject(persistGrouping)
+            ? PersistenceProvider.mergePersistOptions(rootPersistWith, persistGrouping)
+            : rootPersistWith;
         PersistenceProvider.create({
             persistOptions: {
                 path: `${path}.groupBy`,
@@ -54,7 +58,9 @@ export function initPersist(
     }
 
     if (persistSort) {
-        const persistWith = isObject(persistSort) ? persistSort : rootPersistWith;
+        const persistWith = isObject(persistSort)
+            ? PersistenceProvider.mergePersistOptions(rootPersistWith, persistSort)
+            : rootPersistWith;
         PersistenceProvider.create({
             persistOptions: {
                 path: `${path}.sortBy`,

package/core/HoistBase.ts

@@ -261,8 +261,7 @@ export abstract class HoistBase {
         PersistenceProvider.create({
             persistOptions: {
                 path: property,
-                ...this.persistWith,
-                ...options
+                ...PersistenceProvider.mergePersistOptions(this.persistWith, options)
             },
             owner: this,
             target: {

package/core/HoistBaseDecorators.ts

@@ -81,7 +81,10 @@ function createPersistDescriptor(
         // codeValue undefined if no initial in-code value provided, otherwise call to get initial value.
         ret = codeValue?.call(this);
 
-        const persistOptions = {path: property, ...this.persistWith, ...options};
+        const persistOptions = {
+            path: property,
+            ...PersistenceProvider.mergePersistOptions(this.persistWith, options)
+        };
         PersistenceProvider.create({
             persistOptions,
             owner: this,

package/core/persist/PersistenceProvider.ts

@@ -8,12 +8,14 @@
 import {logDebug, logError, throwIf} from '@xh/hoist/utils/js';
 import {
     cloneDeep,
+    compact,
     debounce as lodashDebounce,
     get,
     isEmpty,
     isNumber,
     isString,
     isUndefined,
+    omit,
     set,
     toPath
 } from 'lodash';
@@ -91,6 +93,35 @@ export abstract class PersistenceProvider<S = any> {
         }
     }
 
+    /**
+     * Merge PersistOptions, respecting provider types, with later options overriding earlier ones.
+     */
+    static mergePersistOptions(
+        defaults: PersistOptions,
+        ...overrides: PersistOptions[]
+    ): PersistOptions {
+        const TYPE_RELATED_KEYS = [
+            'type',
+            'prefKey',
+            'localStorageKey',
+            'sessionStorageKey',
+            'dashViewModel',
+            'viewManagerModel',
+            'getData',
+            'setData'
+        ];
+        return compact(overrides).reduce(
+            (ret, override) =>
+                TYPE_RELATED_KEYS.some(key => override[key])
+                    ? {
+                          ...omit(ret, ...TYPE_RELATED_KEYS),
+                          ...override
+                      }
+                    : {...ret, ...override},
+            defaults
+        );
+    }
+
     /** Read persisted state at this provider's path. */
     read(): PersistableState<S> {
         const state = get(this.readRaw(), this.path);

package/data/Store.ts

@@ -435,7 +435,7 @@ export class Store extends HoistBase {
             // sourced from the server / source of record and are coming in as committed.
             this._committed = this._committed.withTransaction(rsTransaction);
 
-            if (this.isModified) {
+            if (this.isDirty) {
                 // If this store had pre-existing local modifications, apply the updates over that
                 // local state. This might (or might not) effectively overwrite those local changes,
                 // so we normalize against the newly updated committed state to verify if any local
@@ -662,8 +662,13 @@ export class Store extends HoistBase {
     }
 
     /** Records modified locally since they were last loaded. */
+    get dirtyRecords(): StoreRecord[] {
+        return this.allRecords.filter(it => it.isDirty);
+    }
+
+    /** Alias for {@link Store.dirtyRecords} */
     get modifiedRecords(): StoreRecord[] {
-        return this.allRecords.filter(it => it.isModified);
+        return this.dirtyRecords;
     }
 
     /**
@@ -696,10 +701,15 @@ export class Store extends HoistBase {
 
     /** True if the store has changes which need to be committed. */
     @computed
-    get isModified(): boolean {
+    get isDirty(): boolean {
         return this._current !== this._committed;
     }
 
+    /** Alias for {@link Store.isDirty} */
+    get isModified(): boolean {
+        return this.isDirty;
+    }
+
     /**
      * Set a filter on this store.
      *

package/data/StoreRecord.ts

@@ -71,10 +71,15 @@ export class StoreRecord {
     }
 
     /** True if the StoreRecord has been modified since it was last committed. */
-    get isModified(): boolean {
+    get isDirty(): boolean {
         return this.committedData && this.committedData !== this.data;
     }
 
+    /** Alias for {@link StoreRecord.isDirty} */
+    get isModified(): boolean {
+        return this.isDirty;
+    }
+
     /** False if the StoreRecord has been added or modified. */
     get isCommitted(): boolean {
         return this.committedData === this.data;

package/data/cube/row/BaseRow.ts

@@ -7,7 +7,7 @@
 
 import {PlainObject, Some} from '@xh/hoist/core';
 import {BucketSpec} from '@xh/hoist/data/cube/BucketSpec';
-import {isEmpty, reduce} from 'lodash';
+import {compact, isEmpty, reduce} from 'lodash';
 import {View} from '../View';
 import {RowUpdate} from './RowUpdate';
 
@@ -97,7 +97,8 @@ export abstract class BaseRow {
         }
 
         // Recurse
-        return children.flatMap(it => it.getVisibleDatas());
+        const ret = compact(children.flatMap(it => it.getVisibleDatas()));
+        return !isEmpty(ret) ? ret : null;
     }
 
     private isRedundantChild(parent: any, child: any) {

package/mobile/cmp/navigator/NavigatorModel.ts

@@ -149,6 +149,7 @@ export class NavigatorModel extends HoistModel {
         // to propagate to scrollable elements within the page.
         swiper.on('touchStart', (s, event: PointerEvent) => {
             swiper.allowTouchMove = false;
+            swiper.params.shortSwipes = true;
             this._touchStartX = event.pageX;
         });
 
@@ -175,6 +176,12 @@ export class NavigatorModel extends HoistModel {
                     swiper.allowTouchMove =
                         swiper.progress < 1 || !isDraggableEl(scrollableParent, 'right');
 
+                    // Disable short swipes to prevent accidental navigation when reaching the
+                    // end of the scrollable parent.
+                    if (!swiper.allowTouchMove) {
+                        swiper.params.shortSwipes = false;
+                    }
+
                     // During the swiper transition, undo the scrollable parent's internal scroll
                     // to keep it static.
                     if (swiper.progress < 1) {

package/package.json

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