@xh/hoist 72.0.0 → 72.2.0

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/tab/TabContainerModel.ts

@@ -108,7 +108,7 @@ export class TabContainerModel extends HoistModel implements Persistable<{active
     @managed
     refreshContextModel: RefreshContextModel;
 
-    private lastActiveTabId: string;
+    protected lastActiveTabId: string;
 
     constructor({
         tabs = [],
@@ -342,7 +342,7 @@ export class TabContainerModel extends HoistModel implements Persistable<{active
     // Implementation
     //-------------------------
     @action
-    private setActiveTabIdInternal(id) {
+    protected setActiveTabIdInternal(id) {
         const tab = this.findTab(id);
         throwIf(!tab, `Unknown Tab ${id} in TabContainer.`);
         throwIf(tab.disabled, `Cannot activate Tab ${id} because it is disabled!`);
@@ -351,7 +351,7 @@ export class TabContainerModel extends HoistModel implements Persistable<{active
         this.forwardRouterToTab(id);
     }
 
-    private syncWithRouter() {
+    protected syncWithRouter() {
         const {tabs, route} = this,
             {router} = XH,
             state = router.getState();
@@ -364,14 +364,14 @@ export class TabContainerModel extends HoistModel implements Persistable<{active
         }
     }
 
-    private forwardRouterToTab(id) {
+    protected forwardRouterToTab(id) {
         const {route} = this;
         if (route && id) {
             XH.router.forward(route, route + '.' + id);
         }
     }
 
-    private calculateActiveTabId(tabs) {
+    protected calculateActiveTabId(tabs) {
         let ret;
 
         // try route

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/HoistProps.ts

@@ -118,6 +118,7 @@ export interface LayoutProps {
     flexGrow?: string | number;
     flexShrink?: string | number;
     flexWrap?: Property.FlexWrap;
+    gap?: string | number;
 
     alignItems?: string;
     alignSelf?: string;

package/core/XH.ts

@@ -54,6 +54,7 @@ import {
     MessageSpec,
     PageState,
     PlainObject,
+    ReloadAppOptions,
     SizingMode,
     TaskObserver,
     Theme,
@@ -64,7 +65,7 @@ import {installServicesAsync} from './impl/InstallServices';
 import {instanceManager} from './impl/InstanceManager';
 import {HoistModel, ModelSelector, RefreshContextModel} from './model';
 
-export const MIN_HOIST_CORE_VERSION = '21.0';
+export const MIN_HOIST_CORE_VERSION = '28.0';
 
 declare const xhAppCode: string;
 declare const xhAppName: string;
@@ -392,18 +393,25 @@ export class XHApi {
     /**
      * Trigger a full reload of the current application.
      *
-     * @param path - relative path to reload (e.g. 'mobile/').  Defaults to the
-     * existing location pathname.
+     * @param opts - options to govern reload. To support legacy usages, a provided
+     *       string will be treated as `ReloadAppOptions.path`.
      *
      * This method will reload the entire application document in the browser - to trigger a
      * refresh of the loadable content within the app, use {@link refreshAppAsync} instead.
      */
     @action
-    reloadApp(path?: string) {
+    reloadApp(opts?: ReloadAppOptions | string) {
         never().linkTo(this.appLoadModel);
+
+        opts = isString(opts) ? {path: opts} : (opts ?? {});
+
         const {location} = window,
-            href = path ? `${location.origin}/${path.replace(/^\/+/, '')}` : location.href,
+            href = opts.path
+                ? `${location.origin}/${opts.path.replace(/^\/+/, '')}`
+                : location.href,
             url = new URL(href);
+
+        if (opts.removeQueryParams) url.search = '';
         // Add a unique query param to force a full reload without using the browser cache.
         url.searchParams.set('xhCacheBuster', Date.now().toString());
         document.location.assign(url);

package/core/exception/Exception.ts

@@ -7,7 +7,7 @@
 import {PlainObject, XH} from '@xh/hoist/core';
 import {FetchOptions} from '@xh/hoist/svc';
 import {pluralize} from '@xh/hoist/utils/js';
-import {isPlainObject} from 'lodash';
+import {isPlainObject, truncate} from 'lodash';
 import {FetchException, HoistException, TimeoutException, TimeoutExceptionConfig} from './Types';
 
 /**
@@ -90,17 +90,16 @@ export class Exception {
         // Try to "smart" decode as server provided JSON Exception (with a name)
         try {
             const cType = headers.get('Content-Type');
-            if (cType && cType.includes('application/json')) {
-                const serverDetails = JSON.parse(responseText);
-                if (serverDetails?.name) {
-                    return this.createFetchException({
-                        ...defaults,
-                        name: serverDetails.name,
-                        message: serverDetails.message,
-                        isRoutine: serverDetails.isRoutine ?? false,
-                        serverDetails
-                    });
-                }
+            if (cType?.includes('application/json')) {
+                const obj = safeParseJson(responseText),
+                    message = obj ? obj.message : truncate(responseText?.trim(), {length: 255});
+                return this.createFetchException({
+                    ...defaults,
+                    name: obj?.name ?? defaults.name,
+                    message: message ?? statusText,
+                    isRoutine: obj?.isRoutine ?? false,
+                    serverDetails: obj ?? responseText
+                });
             }
         } catch (ignored) {}
 
@@ -222,6 +221,14 @@ export class Exception {
     }
 }
 
+function safeParseJson(txt: string): PlainObject {
+    try {
+        return JSON.parse(txt);
+    } catch (ignored) {
+        return null;
+    }
+}
+
 export function isHoistException(src: unknown): src is HoistException {
     return src?.['isHoistException'];
 }

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/core/types/Interfaces.ts

@@ -28,6 +28,17 @@ export interface HoistUser {
     hasGate(s: string): boolean;
 }
 
+/**
+ * Options governing XH.reloadApp().
+ */
+export interface ReloadAppOptions {
+    /** Relative path to reload (e.g. 'mobile/').  Defaults to the existing location pathname. */
+    path?: string;
+
+    /** Should the query parameters be removed from the url before reload.  Default false. */
+    removeQueryParams?: boolean;
+}
+
 /**
  * Options for showing a "toast" notification that appears and then automatically dismisses.
  */

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/desktop/appcontainer/ExceptionDialog.ts

@@ -79,7 +79,7 @@ export const dismissButton = hoistCmp.factory<ExceptionDialogModel>(({model}) =>
               icon: Icon.refresh(),
               text: 'Reload App',
               autoFocus: true,
-              onClick: () => XH.reloadApp()
+              onClick: () => XH.reloadApp({removeQueryParams: true})
           })
         : button({
               text: 'Close',

package/desktop/cmp/dash/canvas/DashCanvas.ts

@@ -18,7 +18,7 @@ import {
 import {dashCanvasAddViewButton} from '@xh/hoist/desktop/cmp/button/DashCanvasAddViewButton';
 import '@xh/hoist/desktop/register';
 import {Classes, overlay} from '@xh/hoist/kit/blueprint';
-import {TEST_ID} from '@xh/hoist/utils/js';
+import {consumeEvent, TEST_ID} from '@xh/hoist/utils/js';
 import classNames from 'classnames';
 import ReactGridLayout, {WidthProvider} from 'react-grid-layout';
 import {DashCanvasModel} from './DashCanvasModel';
@@ -125,6 +125,7 @@ const onContextMenu = (e, model) => {
             x = clientX + model.ref.current.scrollLeft,
             y = clientY + model.ref.current.scrollTop;
 
+        consumeEvent(e);
         showContextMenu(
             dashCanvasContextMenu({
                 dashCanvasModel: model,

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.2.0",
   "description": "Hoist add-on for building and deploying React Applications.",
   "repository": "github:xh/hoist-react",
   "homepage": "https://xh.io",

package/security/BaseOAuthClient.ts

@@ -9,16 +9,17 @@ import {HoistBase, managed, XH} from '@xh/hoist/core';
 import {Icon} from '@xh/hoist/icon';
 import {action, makeObservable} from '@xh/hoist/mobx';
 import {never, wait} from '@xh/hoist/promise';
-import {Token, TokenMap} from '@xh/hoist/security/Token';
+import {Token} from '@xh/hoist/security/Token';
+import {AccessTokenSpec, TokenMap} from './Types';
 import {Timer} from '@xh/hoist/utils/async';
 import {MINUTES, olderThan, ONE_MINUTE, SECONDS} from '@xh/hoist/utils/datetime';
 import {isJSON, throwIf} from '@xh/hoist/utils/js';
-import {find, forEach, isEmpty, isObject, keys, pickBy, union} from 'lodash';
+import {find, forEach, isEmpty, isObject, keys, map, pickBy, union} from 'lodash';
 import ShortUniqueId from 'short-unique-id';
 
 export type LoginMethod = 'REDIRECT' | 'POPUP';
 
-export interface BaseOAuthClientConfig<S> {
+export interface BaseOAuthClientConfig<S extends AccessTokenSpec> {
     /** Client ID (GUID) of your app registered with your Oauth provider. */
     clientId: string;
 
@@ -45,26 +46,17 @@ export interface BaseOAuthClientConfig<S> {
      * Governs an optional refresh timer that will work to keep the tokens fresh.
      *
      * A typical refresh will use the underlying provider cache, and should not result in
-     * network activity. However, if any token lifetime falls below`autoRefreshSkipCacheSecs`,
+     * network activity. However, if any token would expire before the next autoRefresh,
      * this client will force a call to the underlying provider to get the token.
      *
      * In order to allow aging tokens to be replaced in a timely manner, this value should be
      * significantly shorter than both the minimum token lifetime that will be
-     * returned by the underlying API and `autoRefreshSkipCacheSecs`.
+     * returned by the underlying API.
      *
      * Default is -1, disabling this behavior.
      */
     autoRefreshSecs?: number;
 
-    /**
-     * During auto-refresh, if the remaining lifetime for any token is below this threshold,
-     * force the provider to skip the local cache and go directly to the underlying provider for
-     * new tokens and refresh tokens.
-     *
-     * Default is -1, disabling this behavior.
-     */
-    autoRefreshSkipCacheSecs?: number;
-
     /**
      * Scopes to request - if any - beyond the core `['openid', 'email']` scopes, which
      * this client will always request.
@@ -89,13 +81,15 @@ export interface BaseOAuthClientConfig<S> {
  * suitable concrete implementation to power a client-side OauthService. See `MsalClient` and
  * `AuthZeroClient`
  *
- * Initialize such a service and this client within the `preAuthInitAsync()` lifecycle method of
- * `AppModel` to use the tokens it acquires to authenticate with the Hoist server. (Note this
- * requires a suitable server-side `AuthenticationService` implementation to validate the token and
- * actually resolve the user.) On init, the client implementation will initiate a pop-up or redirect
- * flow as necessary.
+ * Initialize such a service and this client within an app's primary {@link HoistAuthModel} to use
+ * the tokens it acquires to authenticate with the Hoist server. (Note this requires a suitable
+ * server-side `AuthenticationService` implementation to validate the token and actually resolve
+ * the user.) On init, the client impl will initiate a pop-up or redirect flow as necessary.
  */
-export abstract class BaseOAuthClient<C extends BaseOAuthClientConfig<S>, S> extends HoistBase {
+export abstract class BaseOAuthClient<
+    C extends BaseOAuthClientConfig<S>,
+    S extends AccessTokenSpec
+> extends HoistBase {
     /** Config loaded from UI server + init method. */
     protected config: C;
 
@@ -121,7 +115,6 @@ export abstract class BaseOAuthClient<C extends BaseOAuthClientConfig<S>, S> ext
             redirectUrl: 'APP_BASE_URL',
             postLogoutRedirectUrl: 'APP_BASE_URL',
             autoRefreshSecs: -1,
-            autoRefreshSkipCacheSecs: -1,
             ...config
         };
         throwIf(!config.clientId, 'Missing OAuth clientId. Please review your configuration.');
@@ -175,10 +168,10 @@ export abstract class BaseOAuthClient<C extends BaseOAuthClientConfig<S>, S> ext
     }
 
     /**
-     * Get all available tokens.
+     * Get all configured tokens.
      */
-    async getAllTokensAsync(): Promise<TokenMap> {
-        return this.fetchAllTokensAsync(true);
+    async getAllTokensAsync(opts?: {eagerOnly?: boolean; useCache?: boolean}): Promise<TokenMap> {
+        return this.fetchAllTokensAsync(opts);
     }
 
     /**
@@ -314,12 +307,27 @@ export abstract class BaseOAuthClient<C extends BaseOAuthClientConfig<S>, S> ext
         await never();
     }
 
-    protected async fetchAllTokensAsync(useCache = true): Promise<TokenMap> {
-        const ret: TokenMap = {},
-            {accessSpecs} = this;
-        for (const key of keys(accessSpecs)) {
-            ret[key] = await this.fetchAccessTokenAsync(accessSpecs[key], useCache);
-        }
+    protected async fetchAllTokensAsync(opts?: {
+        eagerOnly?: boolean;
+        useCache?: boolean;
+    }): Promise<TokenMap> {
+        const eagerOnly = opts?.eagerOnly ?? false,
+            useCache = opts?.useCache ?? true,
+            accessSpecs = eagerOnly
+                ? pickBy(this.accessSpecs, spec => spec.fetchMode === 'eager')
+                : this.accessSpecs,
+            ret: TokenMap = {};
+
+        await Promise.allSettled(
+            map(accessSpecs, async (spec, key) => {
+                try {
+                    ret[key] = await this.fetchAccessTokenAsync(spec, useCache);
+                } catch (e) {
+                    XH.handleException(e, {logOnServer: true, showAlert: false});
+                }
+            })
+        );
+
         // Do this after getting any access tokens --which can also populate the idToken cache!
         ret.id = await this.fetchIdTokenSafeAsync(useCache);
 
@@ -361,22 +369,19 @@ export abstract class BaseOAuthClient<C extends BaseOAuthClientConfig<S>, S> ext
     private async onTimerAsync(): Promise<void> {
         const {config, lastRefreshAttempt} = this,
             refreshSecs = config.autoRefreshSecs * SECONDS,
-            skipCacheSecs = config.autoRefreshSkipCacheSecs * SECONDS;
+            skipCacheSecs = refreshSecs + 5 * SECONDS;
 
         if (olderThan(lastRefreshAttempt, refreshSecs)) {
             this.lastRefreshAttempt = Date.now();
             try {
                 this.logDebug('Refreshing all tokens:');
                 let tokens = await this.fetchAllTokensAsync(),
-                    aging = pickBy(
-                        tokens,
-                        v => skipCacheSecs > 0 && v.expiresWithin(skipCacheSecs)
-                    );
+                    aging = pickBy(tokens, v => v.expiresWithin(skipCacheSecs));
                 if (!isEmpty(aging)) {
                     this.logDebug(
                         `Tokens [${keys(aging).join(', ')}] have < ${skipCacheSecs}s remaining, reloading without cache.`
                     );
-                    tokens = await this.fetchAllTokensAsync(false);
+                    tokens = await this.fetchAllTokensAsync({useCache: false});
                 }
                 this.logTokensDebug(tokens);
             } catch (e) {

package/security/Token.ts

@@ -11,8 +11,6 @@ import {jwtDecode} from 'jwt-decode';
 import {getRelativeTimestamp} from '@xh/hoist/cmp/relativetimestamp';
 import {isNil} from 'lodash';
 
-export type TokenMap = Record<string, Token>;
-
 export class Token {
     readonly value: string;
     readonly decoded: PlainObject;

package/security/Types.ts

@@ -0,0 +1,22 @@
+/*
+ * This file belongs to Hoist, an application development toolkit
+ * developed by Extremely Heavy Industries (www.xh.io | info@xh.io)
+ *
+ * Copyright © 2025 Extremely Heavy Industries Inc.
+ */
+
+import {Token} from './Token';
+
+export type TokenMap = Record<string, Token>;
+
+export interface AccessTokenSpec {
+    /**
+     * Mode governing when the access token should be requested from provider.
+     *      eager (default) - initiate lookup on initialization, but do not block on failure.
+     *      lazy - lookup when requested by client.
+     */
+    fetchMode: 'eager' | 'lazy';
+
+    /** Scopes for the desired access token.*/
+    scopes: string[];
+}