@xh/hoist 78.0.0-SNAPSHOT.1763737348746 → 78.1.0

package/CHANGELOG.md

@@ -1,6 +1,23 @@
 # Changelog
 
-## 78.0.0-SNAPSHOT - unreleased
+## 78.1.0 - 2025-12-02
+
+### ⚙️ Technical
+* New property `MsalClientConfig.enableSsoSilent` to govern use of MSAL SSO api.
+
+* Existing property `MsalClientConfig.enableTelemetry` now defaults to `true`.
+
+* Improved use of MSAL client API, to maximize effectiveness of SSO.  Improved documentation
+ and logging.  Iframe attempts will now time out by default after 3 seconds vs. 10 seconds.
+ This can be further modified by apps via the option
+ `MsalClientConfig.msalClientOptions.system.iFrameHashTimeout`
+
+### 📚 Libraries
+
+* @auth0/auth0-spa-js `2.7 → 2.9`
+* @azure/msal-browser `4.25 → 4.26`
+
+## 78.0.0 - 2025-11-21
 
 ### 💥 Breaking Changes
 
@@ -27,13 +44,18 @@
 
 ### ⚙️ Technical
 
-* Updated the Cube API's `BucketSpecFn` to return either a concrete `BucketSpec` class instance (as
-  before) or a plain object conforming to the new `BucketSpecConfig` interface.
+* Improved documentation on `BucketSpec` class.
 * Enhanced `FetchService` to recognize variants on the `application/json` content-type when
   processing failed responses and decoding exceptions - e.g. `application/problem+json`.
 
 ## 77.1.1 - 2025-11-12
 
+### 💥 Breaking Changes (upgrade difficulty: 🟢 LOW)
+
+* Apps that use and provide the `highcharts` library should be sure to update the version to v12.4.0.
+  Refer to `Bootstrap.js` in Toolbox for required import changes.
+    * Visit https://www.highcharts.com/blog/changelog/ for specific changes.
+
 ### 🎁 New Features
 
 * New method `StoreRecord.getModifiedValues()` to gather edited data from a store record.

package/admin/differ/Differ.ts

@@ -64,7 +64,7 @@ const tbar = hoistCmp.factory<DifferModel>(({model}) => {
             placeholder: 'https://remote-host/',
             enableCreate: true,
             createMessageFn: identity,
-            width: 250,
+            width: 350,
             options: model.remoteHosts
         }),
         button({

package/admin/differ/DifferModel.ts

@@ -60,8 +60,14 @@ export class DifferModel extends HoistModel {
         recordsRequired: true
     };
 
+    /**
+     * All other configured appInstances URLs, excepting the current one.
+     * (Use of startsWith allows configs to end in trailing /)
+     */
     get remoteHosts(): string[] {
-        return XH.getConf('xhAppInstances').filter(it => it !== window.location.origin);
+        return XH.getConf('xhAppInstances').filter(
+            (it: string) => !it.startsWith(window.location.origin)
+        );
     }
 
     constructor({
@@ -83,6 +89,9 @@ export class DifferModel extends HoistModel {
 
         this.url = entityName + 'DiffAdmin';
 
+        // Default to first available remote for comparison
+        this.remoteHost = this.remoteHosts[0];
+
         const rendererIsComplex = true;
         this.gridModel = new GridModel({
             store: {

package/build/types/admin/differ/DifferModel.d.ts

@@ -24,6 +24,10 @@ export declare class DifferModel extends HoistModel {
     hasLoaded: boolean;
     get readonly(): boolean;
     applyRemoteAction: RecordActionSpec;
+    /**
+     * All other configured appInstances URLs, excepting the current one.
+     * (Use of startsWith allows configs to end in trailing /)
+     */
     get remoteHosts(): string[];
     constructor({ parentModel, entityName, displayName, columnFields, matchFields, valueRenderer }: Partial<DifferModel>);
     doLoadAsync(loadSpec: LoadSpec): Promise<void>;

package/build/types/cmp/grid/GridModel.d.ts

@@ -326,39 +326,39 @@ export declare class GridModel extends HoistModel {
     localExport(filename: string, type: 'excel' | 'csv', params?: PlainObject): void;
     /**
      * Select records in the grid.
-     *
      * @param records - one or more record(s) / ID(s) to select.
-     * @param options - additional options containing the following keys:
-     *      ensureVisible - true to make selection visible if it is within a
-     *          collapsed node or outside of the visible scroll window. Default true.
-     *      clearSelection - true to clear previous selection (rather than
-     *          add to it). Default true.
+     * @param opts - additional post-selection options
      */
     selectAsync(records: Some<StoreRecordOrId>, opts?: {
+        /**
+         * True (default) to scroll the grid or expand nodes as needed to make selection
+         * visible if it is within a collapsed node or outside of the visible scroll window.
+         */
         ensureVisible?: boolean;
+        /** True (default) to clear previous selection (rather than add to it). */
         clearSelection?: boolean;
     }): Promise<void>;
     /**
      * Select the first row in the grid.
      *
-     * See {@link preSelectFirstAsync} for a useful variant of this method.  preSelectFirstAsync()
-     * will not change the selection if there is already a selection, which is what applications
-     * typically want to do when loading/reloading a grid.
-     *
-     * @param opts -
-     *      expandParentGroups - set to true to expand nodes to allow selection when the
-     *          first selectable node is in a collapsed group. Default true.
-     *      ensureVisible - set to to true to scroll to the selected row if it is outside of the
-     *      visible scroll window. Default true.
-     *
+     * See {@link preSelectFirstAsync} for a useful variant of this method that will leave the
+     * any pre-existing selection unchanged, which is what apps typically want when reloading an
+     * already-populated grid.
      */
     selectFirstAsync(opts?: {
+        /**
+         * True (default) to expand nodes as needed to allow selection when the first selectable
+         * node is in a collapsed group.
+         */
         expandParentGroups?: boolean;
+        /**
+         * True (default) to scroll the grid or expand nodes as needed to make selection
+         * visible if it is outside of the visible scroll window.
+         */
         ensureVisible?: boolean;
     }): Promise<void>;
     /**
      * Select the first row in the grid, if no other selection present.
-     *
      * This method delegates to {@link selectFirstAsync}.
      */
     preSelectFirstAsync(): Promise<void>;

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

@@ -20,6 +20,8 @@ export type Thunkable<T> = T | (() => T);
 export type Awaitable<T> = Promise<T> | T;
 /** Convenience type for a "plain", string-keyed object holding any kind of values. */
 export type PlainObject = Record<string, any>;
+/** Convenience type to make a set of keys optional in a given type. */
+export type SetOptional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
 /**
  * Specification for debouncing in Hoist.
  *

package/build/types/data/cube/BucketSpec.d.ts

@@ -1,4 +1,5 @@
 import { BaseRow } from './row/BaseRow';
+import { SetOptional } from '@xh/hoist/core';
 /**
  * Spec to define a bucketing level within the hierarchy of data returned by a Query, as identified
  * by a set of rows passed to a {@link BucketSpecFn} configured on that Query (or defaulted from
@@ -6,7 +7,7 @@ import { BaseRow } from './row/BaseRow';
  * spec's `bucketFn` to determine if it should yield a value for the bucket, causing the row to be
  * nested underneath a new {@link BucketRow} created to hold all rows with that value.
  */
-export interface BucketSpecConfig {
+export declare class BucketSpec {
     /** Name for the bucketing level configured by this spec - equivalent to a dimension name. */
     name: string;
     /**
@@ -18,19 +19,13 @@ export interface BucketSpecConfig {
      * Function returning bucket row label from the bucket value string returned by bucketFn.
      * Defaults to using the value directly.
      */
-    labelFn?: (bucket: string) => string;
+    labelFn: (bucket: string) => string;
     /**
      * Fields on which the `bucketFn` depends, to ensure rows are re-bucketed if dependent field
      * values change. If not provided or does not cover all fields potentially accessed by
      * `bucketFn`, an incremental "data only" update that should have changed a row's bucket can
      * fail to do so.
      */
-    dependentFields?: string[];
-}
-export declare class BucketSpec {
-    name: string;
-    bucketFn: (row: BaseRow) => string;
-    labelFn: (bucket: string) => string;
     dependentFields: string[];
-    constructor(config: BucketSpecConfig);
+    constructor(config: SetOptional<BucketSpec, 'labelFn' | 'dependentFields'>);
 }

package/build/types/data/cube/Cube.d.ts

@@ -8,7 +8,7 @@ import { StoreRecord } from '../StoreRecord';
 import { AggregateRow } from './row/AggregateRow';
 import { BucketRow } from './row/BucketRow';
 import { BaseRow } from './row/BaseRow';
-import { BucketSpec, BucketSpecConfig } from './BucketSpec';
+import { BucketSpec } from './BucketSpec';
 export interface CubeConfig {
     fields: CubeField[] | CubeFieldSpec[];
     /** Default configs applied to all `CubeField`s constructed internally by this Cube. */
@@ -60,9 +60,9 @@ export type OmitFn = (row: AggregateRow | BucketRow) => boolean;
  * aggregations and create an unwanted "Open" grouping.
  *
  * @param rows - the rows being checked for bucketing
- * @returns {@link BucketSpecConfig} for dynamic sub-aggregations, or null to perform no bucketing.
+ * @returns {@link BucketSpec} for dynamic sub-aggregations, or null to perform no bucketing.
  */
-export type BucketSpecFn = (rows: BaseRow[]) => BucketSpecConfig | BucketSpec;
+export type BucketSpecFn = (rows: BaseRow[]) => BucketSpec;
 /**
  * A data store that supports grouping, aggregating, and filtering data on multiple dimensions.
  *

package/build/types/data/cube/Query.d.ts

@@ -79,7 +79,7 @@ export interface QueryConfig {
      *
      * This can be used to break selected aggregations into sub-groups dynamically, without having
      * to define another dimension in the Cube and have it apply to all aggregations. See the
-     * {@link BucketSpecFn} type and {@link BucketSpecConfig} interface for additional information.
+     * {@link BucketSpecFn} type and {@link BucketSpec} interface for additional information.
      *
      * Defaults to {@link Cube.bucketSpecFn}.
      */

package/build/types/security/msal/MsalClient.d.ts

@@ -19,7 +19,7 @@ export interface MsalClientConfig extends BaseOAuthClientConfig<MsalTokenSpec> {
     domainHint?: string;
     /**
      * True to enable support for built-in telemetry provided by this class's internal MSAL client.
-     * Captured performance events will be summarized as {@link MsalClientTelemetry}.
+     * Captured performance events will be summarized as {@link MsalClientTelemetry}. Default true.
      */
     enableTelemetry?: boolean;
     /**
@@ -42,6 +42,17 @@ export interface MsalClientConfig extends BaseOAuthClientConfig<MsalTokenSpec> {
      * See https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-browser/docs/token-lifetimes.md
      */
     initRefreshTokenExpirationOffsetSecs?: number;
+    /**
+     * Enable the use of the MSAL ssoSilent() API, which will attempt to use credentials gained by
+     * another app or tab to start a new session for this app.  Requires iFrames and 3rd party
+     * cookies to be enabled.  Default true.
+     *
+     *  In practice, and according to documentation, this operation is likely to fail for a
+     *  number of reasons, and can often do so as timeout.  Therefore, keeping the timeout limit
+     *  value -- `system.iFrameHashTimeout` -- at a relatively low value is critical.  Hoist
+     *  defaults this value to 3000ms vs. the default 10000ms.
+     */
+    enableSsoSilent?: boolean;
     /** The log level of MSAL. Default is LogLevel.Warning. */
     msalLogLevel?: LogLevel;
     /**
@@ -105,14 +116,19 @@ export declare class MsalClient extends BaseOAuthClient<MsalClientConfig, MsalTo
     private get loginScopes();
     private get loginExtraScopesToConsent();
     private get refreshOffsetArgs();
-    private noteUserAuthenticated;
+    private setAccount;
+    private noteAuthComplete;
+    private authRequestCore;
 }
+type AuthMethod = 'acquireSilent' | 'ssoSilent' | 'loginPopup' | 'loginRedirect';
 /**
  * Telemetry produced by this client (if enabled) + included in {@link ClientHealthService}
  * reporting. Leverages MSAL's opt-in support for emitting performance events.
  * See https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-browser/docs/performance.md
  */
 interface MsalClientTelemetry {
+    /** Method of last authentication for this client. */
+    authMethod: AuthMethod;
     /** Stats across all events */
     summary: {
         successCount: number;

package/cmp/grid/GridModel.ts

@@ -751,19 +751,22 @@ export class GridModel extends HoistModel {
 
     /**
      * Select records in the grid.
-     *
      * @param records - one or more record(s) / ID(s) to select.
-     * @param options - additional options containing the following keys:
-     *      ensureVisible - true to make selection visible if it is within a
-     *          collapsed node or outside of the visible scroll window. Default true.
-     *      clearSelection - true to clear previous selection (rather than
-     *          add to it). Default true.
+     * @param opts - additional post-selection options
      */
     async selectAsync(
         records: Some<StoreRecordOrId>,
-        opts?: {ensureVisible?: boolean; clearSelection?: boolean}
+        opts: {
+            /**
+             * True (default) to scroll the grid or expand nodes as needed to make selection
+             * visible if it is within a collapsed node or outside of the visible scroll window.
+             */
+            ensureVisible?: boolean;
+            /** True (default) to clear previous selection (rather than add to it). */
+            clearSelection?: boolean;
+        } = {}
     ) {
-        const {ensureVisible = true, clearSelection = true} = opts ?? {};
+        const {ensureVisible = true, clearSelection = true} = opts;
         this.selModel.select(records, clearSelection);
         if (ensureVisible) await this.ensureSelectionVisibleAsync();
     }
@@ -771,19 +774,25 @@ export class GridModel extends HoistModel {
     /**
      * Select the first row in the grid.
      *
-     * See {@link preSelectFirstAsync} for a useful variant of this method.  preSelectFirstAsync()
-     * will not change the selection if there is already a selection, which is what applications
-     * typically want to do when loading/reloading a grid.
-     *
-     * @param opts -
-     *      expandParentGroups - set to true to expand nodes to allow selection when the
-     *          first selectable node is in a collapsed group. Default true.
-     *      ensureVisible - set to to true to scroll to the selected row if it is outside of the
-     *      visible scroll window. Default true.
-     *
+     * See {@link preSelectFirstAsync} for a useful variant of this method that will leave the
+     * any pre-existing selection unchanged, which is what apps typically want when reloading an
+     * already-populated grid.
      */
-    async selectFirstAsync(opts?: {expandParentGroups?: boolean; ensureVisible?: boolean}) {
-        const {expandParentGroups = true, ensureVisible = true} = opts ?? {};
+    async selectFirstAsync(
+        opts: {
+            /**
+             * True (default) to expand nodes as needed to allow selection when the first selectable
+             * node is in a collapsed group.
+             */
+            expandParentGroups?: boolean;
+            /**
+             * True (default) to scroll the grid or expand nodes as needed to make selection
+             * visible if it is outside of the visible scroll window.
+             */
+            ensureVisible?: boolean;
+        } = {}
+    ) {
+        const {expandParentGroups = true, ensureVisible = true} = opts;
         await this.whenReadyAsync();
         if (!this.isReady) return;
 
@@ -803,7 +812,6 @@ export class GridModel extends HoistModel {
 
     /**
      * Select the first row in the grid, if no other selection present.
-     *
      * This method delegates to {@link selectFirstAsync}.
      */
     async preSelectFirstAsync() {

package/core/types/Types.ts

@@ -34,6 +34,9 @@ export type Awaitable<T> = Promise<T> | T;
 /** Convenience type for a "plain", string-keyed object holding any kind of values. */
 export type PlainObject = Record<string, any>;
 
+/** Convenience type to make a set of keys optional in a given type. */
+export type SetOptional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
+
 /**
  * Specification for debouncing in Hoist.
  *

package/data/Store.ts

@@ -763,7 +763,10 @@ export class Store extends HoistBase {
     /** True if the store has changes which need to be committed. */
     @computed
     get isDirty(): boolean {
-        return this._current !== this._committed || this.summaryRecords?.some(it => it.isModified);
+        return (
+            this._current !== this._committed ||
+            (this.summaryRecords?.some(it => it.isModified) ?? false)
+        );
     }
 
     /** Alias for {@link Store.isDirty} */

package/data/cube/BucketSpec.ts

@@ -6,6 +6,7 @@
  */
 
 import {BaseRow} from './row/BaseRow';
+import {SetOptional} from '@xh/hoist/core';
 
 /**
  * Spec to define a bucketing level within the hierarchy of data returned by a Query, as identified
@@ -14,35 +15,31 @@ import {BaseRow} from './row/BaseRow';
  * spec's `bucketFn` to determine if it should yield a value for the bucket, causing the row to be
  * nested underneath a new {@link BucketRow} created to hold all rows with that value.
  */
-export interface BucketSpecConfig {
+export class BucketSpec {
     /** Name for the bucketing level configured by this spec - equivalent to a dimension name. */
     name: string;
+
     /**
      * Function returning the bucketed value (if any) into which the given row should be placed -
      * equivalent to a dimension value. Return null/undefined to exclude the row from bucketing.
      */
     bucketFn: (row: BaseRow) => string;
+
     /**
      * Function returning bucket row label from the bucket value string returned by bucketFn.
      * Defaults to using the value directly.
      */
-    labelFn?: (bucket: string) => string;
+    labelFn: (bucket: string) => string;
+
     /**
      * Fields on which the `bucketFn` depends, to ensure rows are re-bucketed if dependent field
      * values change. If not provided or does not cover all fields potentially accessed by
      * `bucketFn`, an incremental "data only" update that should have changed a row's bucket can
      * fail to do so.
      */
-    dependentFields?: string[];
-}
-
-export class BucketSpec {
-    name: string;
-    bucketFn: (row: BaseRow) => string;
-    labelFn: (bucket: string) => string;
     dependentFields: string[];
 
-    constructor(config: BucketSpecConfig) {
+    constructor(config: SetOptional<BucketSpec, 'labelFn' | 'dependentFields'>) {
         this.name = config.name;
         this.bucketFn = config.bucketFn;
         this.labelFn = config.labelFn ?? (b => b);

package/data/cube/Cube.ts

@@ -17,7 +17,7 @@ import {StoreRecord} from '../StoreRecord';
 import {AggregateRow} from './row/AggregateRow';
 import {BucketRow} from './row/BucketRow';
 import {BaseRow} from './row/BaseRow';
-import {BucketSpec, BucketSpecConfig} from './BucketSpec';
+import {BucketSpec} from './BucketSpec';
 import {defaultsDeep, isEmpty} from 'lodash';
 
 export interface CubeConfig {
@@ -82,9 +82,9 @@ export type OmitFn = (row: AggregateRow | BucketRow) => boolean;
  * aggregations and create an unwanted "Open" grouping.
  *
  * @param rows - the rows being checked for bucketing
- * @returns {@link BucketSpecConfig} for dynamic sub-aggregations, or null to perform no bucketing.
+ * @returns {@link BucketSpec} for dynamic sub-aggregations, or null to perform no bucketing.
  */
-export type BucketSpecFn = (rows: BaseRow[]) => BucketSpecConfig | BucketSpec;
+export type BucketSpecFn = (rows: BaseRow[]) => BucketSpec;
 
 /**
  * A data store that supports grouping, aggregating, and filtering data on multiple dimensions.

package/data/cube/Query.ts

@@ -107,7 +107,7 @@ export interface QueryConfig {
      *
      * This can be used to break selected aggregations into sub-groups dynamically, without having
      * to define another dimension in the Cube and have it apply to all aggregations. See the
-     * {@link BucketSpecFn} type and {@link BucketSpecConfig} interface for additional information.
+     * {@link BucketSpecFn} type and {@link BucketSpec} interface for additional information.
      *
      * Defaults to {@link Cube.bucketSpecFn}.
      */

package/data/cube/View.ts

@@ -18,7 +18,6 @@ import {
     StoreRecord,
     StoreRecordId
 } from '@xh/hoist/data';
-import {BucketSpec} from '@xh/hoist/data/cube/BucketSpec';
 import {ViewRowData} from '@xh/hoist/data/cube/ViewRowData';
 import {action, makeObservable, observable} from '@xh/hoist/mobx';
 import {shallowEqualArrays} from '@xh/hoist/utils/impl';
@@ -365,13 +364,9 @@ export class View extends HoistBase {
         if (!query.bucketSpecFn) return rows;
         if (!query.includeLeaves && rows[0]?.isLeaf) return rows;
 
-        const bucketSpecOrConf = query.bucketSpecFn(rows);
-        if (!bucketSpecOrConf) return rows;
+        const bucketSpec = query.bucketSpecFn(rows);
+        if (!bucketSpec) return rows;
 
-        const bucketSpec =
-            bucketSpecOrConf instanceof BucketSpec
-                ? bucketSpecOrConf
-                : new BucketSpec(bucketSpecOrConf);
         const {name: bucketName, bucketFn, dependentFields} = bucketSpec,
             buckets: Record<string, BaseRow[]> = {},
             ret: BaseRow[] = [];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xh/hoist",
-  "version": "78.0.0-SNAPSHOT.1763737348746",
+  "version": "78.1.0",
   "description": "Hoist add-on for building and deploying React Applications.",
   "repository": "github:xh/hoist-react",
   "homepage": "https://xh.io",
@@ -28,8 +28,8 @@
     ]
   },
   "dependencies": {
-    "@auth0/auth0-spa-js": "~2.7.0",
-    "@azure/msal-browser": "~4.25.0",
+    "@auth0/auth0-spa-js": "~2.9.1",
+    "@azure/msal-browser": "~4.26.2",
     "@blueprintjs/core": "^5.10.5",
     "@blueprintjs/datetime": "^5.3.7",
     "@blueprintjs/datetime2": "^2.3.7",

package/security/BaseOAuthClient.ts

@@ -180,8 +180,8 @@ export abstract class BaseOAuthClient<
      * Request a full logout from the underlying OAuth provider.
      */
     async logoutAsync(): Promise<void> {
-        await this.doLogoutAsync();
         this.setSelectedUsername(null);
+        await this.doLogoutAsync();
     }
 
     /**