@xh/hoist 71.0.0-SNAPSHOT.1735062266455 → 71.0.0-SNAPSHOT.1735236372248

package/CHANGELOG.md

@@ -13,7 +13,7 @@
   `@xh/hoist/cmp/loadingindicator`.
 * `TreeMap` and `SplitTreeMap` are now cross-platform and can be used in mobile applications.
   Their import paths have changed from `@xh/hoist/desktop/cmp/treemap` to `@xh/hoist/cmp/treemap`.
-
+* The `RefreshButton` `model` prop has been renamed `target` for clarity and consistency.
 ### 🎁 New Features
 
 * Major Improvements to ViewManager component

package/build/types/desktop/cmp/button/RefreshButton.d.ts

@@ -1,13 +1,16 @@
 /// <reference types="react" />
-import { HoistModel } from '@xh/hoist/core';
+import { Loadable } from '@xh/hoist/core';
 import '@xh/hoist/desktop/register';
 import { ButtonProps } from './Button';
-export type RefreshButtonProps = ButtonProps<HoistModel>;
+export interface RefreshButtonProps extends ButtonProps {
+    /** Object to refresh when clicked. */
+    target?: Loadable;
+}
 /**
  * Convenience Button preconfigured for use as a trigger for a refresh operation.
  *
- * If an onClick handler is provided it will be used. Otherwise this button will
- * be linked to any model in props with LoadSupport enabled, or the contextual
+ * If an onClick handler is provided it will be used. Otherwise, this button will
+ * be linked to the target in props with LoadSupport enabled, or the contextual
  * See {@link RefreshContextModel}.
  */
 export declare const RefreshButton: import("react").FC<RefreshButtonProps>, refreshButton: import("@xh/hoist/core").ElementFactory<RefreshButtonProps>;

package/build/types/mobile/cmp/button/RefreshButton.d.ts

@@ -1,8 +1,11 @@
 /// <reference types="react" />
-import { HoistModel } from '@xh/hoist/core';
+import { Loadable } from '@xh/hoist/core';
 import { ButtonProps } from '@xh/hoist/mobile/cmp/button';
 import '@xh/hoist/mobile/register';
-export type RefreshButtonProps = ButtonProps<HoistModel>;
+export interface RefreshButtonProps extends ButtonProps {
+    /** Object to refresh when clicked. */
+    target?: Loadable;
+}
 /**
  * Convenience Button preconfigured for use as a trigger for a refresh operation.
  *

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

@@ -1,4 +1,4 @@
-import { HoistService } from '@xh/hoist/core';
+import { HoistService, TrackOptions } from '@xh/hoist/core';
 import { GridModel, Column } from '@xh/hoist/cmp/grid';
 import { StoreRecord } from '@xh/hoist/data';
 /**
@@ -50,7 +50,7 @@ export interface ExportOptions {
      */
     columns?: 'VISIBLE' | 'ALL' | string[] | ((g: GridModel) => string[]);
     /** True to enable activity tracking of exports (default false). */
-    track?: boolean;
+    track?: boolean | Partial<TrackOptions>;
     /** Timeout (in ms) for export request - defaults to 30 seconds. */
     timeout?: number;
 }

package/desktop/cmp/button/RefreshButton.ts

@@ -4,35 +4,34 @@
  *
  * Copyright © 2024 Extremely Heavy Industries Inc.
  */
-import {hoistCmp, HoistModel, RefreshContextModel, useContextModel} from '@xh/hoist/core';
+import {hoistCmp, Loadable, RefreshContextModel, useContextModel} from '@xh/hoist/core';
 import '@xh/hoist/desktop/register';
 import {Icon} from '@xh/hoist/icon';
-import {errorIf, withDefault} from '@xh/hoist/utils/js';
 import {button, ButtonProps} from './Button';
+import {apiRemoved} from '@xh/hoist/utils/js';
 
-export type RefreshButtonProps = ButtonProps<HoistModel>;
+export interface RefreshButtonProps extends ButtonProps {
+    /** Object to refresh when clicked. */
+    target?: Loadable;
+}
 
 /**
  * Convenience Button preconfigured for use as a trigger for a refresh operation.
  *
- * If an onClick handler is provided it will be used. Otherwise this button will
- * be linked to any model in props with LoadSupport enabled, or the contextual
+ * If an onClick handler is provided it will be used. Otherwise, this button will
+ * be linked to the target in props with LoadSupport enabled, or the contextual
  * See {@link RefreshContextModel}.
  */
 export const [RefreshButton, refreshButton] = hoistCmp.withFactory<RefreshButtonProps>({
     displayName: 'RefreshButton',
-    model: false, // For consistency with all other buttons -- the model prop here could be replaced by 'target'
+    model: false,
 
-    render({model, onClick, ...props}, ref) {
-        const refreshContextModel = useContextModel(RefreshContextModel);
+    render({target, onClick, ...props}, ref) {
+        apiRemoved('model', {test: props.model, msg: 'Use target instead.'});
 
+        const refreshContextModel = useContextModel(RefreshContextModel);
         if (!onClick) {
-            let target: HoistModel = model;
-            errorIf(
-                target && !target.loadSupport,
-                'Models provided to RefreshButton must enable LoadSupport.'
-            );
-            target = withDefault(target, refreshContextModel);
+            target ??= refreshContextModel;
             onClick = target ? () => target.refreshAsync() : null;
         }
 

package/desktop/cmp/rest/impl/RestGridToolbar.ts

@@ -55,7 +55,7 @@ export const restGridToolbar = hoistCmp.factory({
                 omit: !model.gridModel.enableExport
             }),
             refreshButton({
-                model,
+                target: model,
                 omit: !model.showRefreshButton
             })
         );

package/desktop/cmp/viewmanager/dialog/ManageDialog.ts

@@ -74,7 +74,7 @@ const selectorPanel = hoistCmp.factory<ManageDialogModel>({
                     onFilterChange: f => (model.filter = f)
                 }),
                 filler(),
-                refreshButton({model})
+                refreshButton({target: model})
             ]
         });
     }

package/mobile/cmp/button/RefreshButton.ts

@@ -4,13 +4,16 @@
  *
  * Copyright © 2024 Extremely Heavy Industries Inc.
  */
-import {hoistCmp, HoistModel, RefreshContextModel, useContextModel} from '@xh/hoist/core';
+import {hoistCmp, Loadable, RefreshContextModel, useContextModel} from '@xh/hoist/core';
 import {Icon} from '@xh/hoist/icon';
 import {button, ButtonProps} from '@xh/hoist/mobile/cmp/button';
 import '@xh/hoist/mobile/register';
-import {errorIf} from '@xh/hoist/utils/js';
+import {apiRemoved} from '@xh/hoist/utils/js';
 
-export type RefreshButtonProps = ButtonProps<HoistModel>;
+export interface RefreshButtonProps extends ButtonProps {
+    /** Object to refresh when clicked. */
+    target?: Loadable;
+}
 
 /**
  * Convenience Button preconfigured for use as a trigger for a refresh operation.
@@ -21,18 +24,15 @@ export type RefreshButtonProps = ButtonProps<HoistModel>;
  */
 export const [RefreshButton, refreshButton] = hoistCmp.withFactory<RefreshButtonProps>({
     displayName: 'RefreshButton',
-    model: false, // For consistency with all other buttons -- the model prop here could be replaced by 'target'
+    model: false,
 
-    render({model, icon = Icon.sync(), onClick, ...props}) {
-        const refreshContextModel = useContextModel(RefreshContextModel);
+    render({target, icon = Icon.sync(), onClick, ...props}) {
+        apiRemoved('model', {test: props.model, msg: 'Use target instead.'});
 
+        const refreshContextModel = useContextModel(RefreshContextModel);
         if (!onClick) {
-            errorIf(
-                model && !model.loadSupport,
-                'Models provided to RefreshButton must enable LoadSupport.'
-            );
-            model = model ?? refreshContextModel;
-            onClick = model ? () => model.refreshAsync() : null;
+            target ??= refreshContextModel;
+            onClick = target ? () => target.refreshAsync() : null;
         }
 
         return button({icon, onClick, ...props});

package/package.json

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

package/svc/GridExportService.ts

@@ -5,17 +5,16 @@
  * Copyright © 2024 Extremely Heavy Industries Inc.
  */
 import {ExcelFormat} from '@xh/hoist/cmp/grid';
-import {HoistService, XH} from '@xh/hoist/core';
+import {HoistService, TrackOptions, XH} from '@xh/hoist/core';
 import {fmtDate} from '@xh/hoist/format';
 import {Icon} from '@xh/hoist/icon';
 import {isLocalDate, SECONDS} from '@xh/hoist/utils/datetime';
-import {throwIf, withDefault} from '@xh/hoist/utils/js';
+import {withDefault} from '@xh/hoist/utils/js';
 import download from 'downloadjs';
 import {StatusCodes} from 'http-status-codes';
 import {
     castArray,
     countBy,
-    isArray,
     isEmpty,
     isFunction,
     isNil,
@@ -56,21 +55,6 @@ export class GridExportService extends HoistService {
             timeout = 30 * SECONDS
         }: ExportOptions = {}
     ) {
-        throwIf(!gridModel, 'GridModel required for export');
-        throwIf(
-            !isString(filename) && !isFunction(filename),
-            'Export filename must be either a string or a closure'
-        );
-        throwIf(
-            !['excel', 'excelTable', 'csv'].includes(type),
-            `Invalid export type "${type}". Must be either "excel", "excelTable" or "csv"`
-        );
-        throwIf(
-            !(isFunction(columns) || isArray(columns) || ['ALL', 'VISIBLE'].includes(columns)),
-            'Invalid columns config - must be "ALL", "VISIBLE", an array of colIds, or a function'
-        );
-        throwIf(!isBoolean(track), 'Invalid track value - must be either true or false');
-
         if (isFunction(filename)) filename = filename(gridModel);
 
         const config = XH.configService.get('xhExportConfig', {}),
@@ -153,11 +137,13 @@ export class GridExportService extends HoistService {
             XH.successToast('Export complete.');
 
             if (track) {
+                const trackOpts = track !== true ? track : null;
                 XH.track({
                     category: 'Export',
                     message: `Downloaded ${filename}${fileExt}`,
                     data: {rows: rows.length, columns: exportColumns.length},
-                    logData: true
+                    logData: true,
+                    ...trackOpts
                 });
             }
         } catch (e) {
@@ -460,7 +446,7 @@ export interface ExportOptions {
     columns?: 'VISIBLE' | 'ALL' | string[] | ((g: GridModel) => string[]);
 
     /** True to enable activity tracking of exports (default false). */
-    track?: boolean;
+    track?: boolean | Partial<TrackOptions>;
 
     /** Timeout (in ms) for export request - defaults to 30 seconds. */
     timeout?: number;