@xh/hoist 55.1.0 → 55.2.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## v55.2.0 - 2023-02-10
+
+### 🎁 New Features
+* `DashCanvas` enhancements:
+    * Views now support minimum and maximum dimensions.
+    * Views now expose an `allowDuplicate` flag for controlling the `Duplicate` menu item visibility.
+
+### 🐞 Bug Fixes
+* Fixed a bug with Cube views having dimensions containing non-string or `null` values.  Rows grouped
+by these dimensions would report values for the dimension which were incorrectly stringified (e.g.
+`null` vs. `'null'` or `'5'` vs. `5`).  This has been fixed.  Note that the stringified value is
+still reported for the rows' `cubeLabel` value, and will be used for the purposes of grouping.
+
+### ⚙️ Typescript API Adjustments
+
+* Improved signatures of `RestStore` APIs.
+
+
 ## v55.1.0 - 2023-02-09
 
 Version 55 is the first major update of the toolkit after our transition to typescript.  In addition

package/data/cube/View.ts

@@ -268,7 +268,7 @@ export class View extends HoistBase {
         if (includeRoot) {
             newRows = [
                 this.cachedRow(rootId, newRows,
-                    () => new AggregateRow(this, rootId, newRows, null, 'Total', {})
+                    () => new AggregateRow(this, rootId, newRows, null, 'Total', 'Total', {})
                 )
             ];
         } else if (!query.includeLeaves && newRows[0]?.isLeaf) {
@@ -308,15 +308,17 @@ export class View extends HoistBase {
             groups = groupBy(records, (it) => it.data[dimName]);
 
         appliedDimensions = {...appliedDimensions};
-        return map(groups, (groupRecords, val) => {
+        return map(groups, (groupRecords, strVal) => {
+            const val = groupRecords[0].data[dimName],
+                id = rootId + `${dimName}=[${strVal}]`;
+
             appliedDimensions[dimName] = val;
-            const id = rootId + `${dimName}=[${val}]`;
 
             let children = this.groupAndInsertRecords(groupRecords, dimensions.slice(1), id, appliedDimensions, leafMap);
             children = this.bucketRows(children, id, appliedDimensions);
 
             return this.cachedRow(id, children,
-                () => new AggregateRow(this, id, children, dim, val, appliedDimensions)
+                () => new AggregateRow(this, id, children, dim, val, strVal, appliedDimensions)
             );
         });
     }

package/data/cube/row/AggregateRow.ts

@@ -25,6 +25,7 @@ export class AggregateRow extends BaseRow {
         children: BaseRow[],
         dim: CubeField,
         val: any,
+        strVal: string,
         appliedDimensions: PlainObject
     ) {
         super(view, id);
@@ -32,7 +33,7 @@ export class AggregateRow extends BaseRow {
 
         this.dim = dim;
         this.dimName = dimName;
-        this.data.cubeLabel = val;
+        this.data.cubeLabel = strVal;
         this.data.cubeDimension = dimName;
 
         this.initAggregate(children, dimName, val, appliedDimensions);

package/desktop/cmp/dash/DashViewModel.ts

@@ -31,12 +31,12 @@ export type DashViewState = Record<string, any>;
  * Content hosted within this view can use this model at runtime to access and set state
  * for the view or access other information.
  */
-export class DashViewModel extends HoistModel {
+export class DashViewModel<T extends DashViewSpec = DashViewSpec> extends HoistModel {
 
     id: string;
 
     /** DashViewSpec used to create this view. */
-    viewSpec: DashViewSpec;
+    viewSpec: T;
 
     /**
      * Parent DashContainerModel or DashCanvasModel. Provided by the container when
@@ -74,7 +74,7 @@ export class DashViewModel extends HoistModel {
         title,
         viewState = null,
         containerModel
-    }: DashViewConfig) {
+    }: DashViewConfig<T>) {
         super();
         makeObservable(this);
         throwIf(!id, 'DashViewModel requires an id');
@@ -99,9 +99,9 @@ export class DashViewModel extends HoistModel {
 }
 
 /** @internal */
-export interface DashViewConfig {
+export interface DashViewConfig<T extends DashViewSpec = DashViewSpec> {
     id: string;
-    viewSpec: DashViewSpec;
+    viewSpec: T;
     icon?: ReactElement;
     title?: string;
     viewState?: DashViewState;

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

@@ -101,10 +101,19 @@ export class DashCanvasModel extends DashModel<DashCanvasViewSpec, DashCanvasIte
     private isLoadingState: boolean;
 
     get rglLayout() {
-        return this.layout.map(it => ({
-            ...it,
-            resizeHandles: this.getView(it.i).autoHeight ? ['e'] : ['e', 's', 'se']
-        }));
+        return this.layout.map(it => {
+            const dashCanvasView = this.getView(it.i),
+                {autoHeight, viewSpec} = dashCanvasView;
+
+            return {
+                ...it,
+                resizeHandles: autoHeight ? ['e'] : ['e', 's', 'se'],
+                maxH: viewSpec.maxHeight,
+                minH: viewSpec.minHeight,
+                maxW: viewSpec.maxWidth,
+                minW: viewSpec.minWidth
+            };
+        });
     }
 
     constructor({
@@ -135,6 +144,7 @@ export class DashCanvasModel extends DashModel<DashCanvasViewSpec, DashCanvasIte
                 omit: false,
                 unique: false,
                 allowAdd: true,
+                allowDuplicate: true,
                 allowRemove: true,
                 allowRename: true,
                 height: 5,
@@ -339,8 +349,8 @@ export class DashCanvasModel extends DashModel<DashCanvasViewSpec, DashCanvasIte
             prevLayout = previousViewId ? this.getViewLayout(previousViewId) : null,
             x = prevLayout?.x ?? layout?.x ?? 0,
             y = prevLayout?.y ?? layout?.y ?? this.rows,
-            h = layout?.h ?? viewSpec.height ?? 1,
-            w = layout?.w ?? viewSpec.width ?? 1;
+            h = layout?.h ?? viewSpec.height ?? viewSpec.minHeight ?? 1,
+            w = layout?.w ?? viewSpec.width ?? viewSpec.minWidth ?? 1;
 
         this.setLayout([...this.layout, {i: id, x, y, h, w}]);
         this.viewModels = [...this.viewModels, model];

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

@@ -4,6 +4,7 @@
  *
  * Copyright © 2022 Extremely Heavy Industries Inc.
  */
+import {DashCanvasViewSpec} from '@xh/hoist/desktop/cmp/dash';
 import {DashViewConfig, DashViewModel} from '../DashViewModel';
 import '@xh/hoist/desktop/register';
 import {createObservableRef} from '@xh/hoist/utils/react';
@@ -13,7 +14,10 @@ import {ReactNode} from 'react';
 /**
  * Model for a content item within a DashCanvas.
  */
-export class DashCanvasViewModel extends DashViewModel {
+export class DashCanvasViewModel extends DashViewModel<DashCanvasViewSpec> {
+
+    /** True (default) to allow duplicating the view. */
+    @observable allowDuplicate: boolean;
 
     /** Hide the Header Panel for the view? Default false. */
     @observable hidePanelHeader: boolean;
@@ -29,9 +33,10 @@ export class DashCanvasViewModel extends DashViewModel {
 
     ref = createObservableRef<HTMLElement>();
 
-    constructor(cfg: DashViewConfig) {
+    constructor(cfg: DashViewConfig<DashCanvasViewSpec>) {
         super(cfg);
         makeObservable(this);
+        this.allowDuplicate = cfg.viewSpec.allowDuplicate ?? true;
         this.hidePanelHeader = !!cfg.viewSpec.hidePanelHeader;
         this.hideMenuButton = !!cfg.viewSpec.hideMenuButton;
         this.autoHeight = !!cfg.viewSpec.autoHeight;

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

@@ -21,6 +21,18 @@ export interface DashCanvasViewSpec extends DashViewSpec {
     /** Initial width of view when added to canvas (default 5). */
     width?: number
 
+    /** Maximum height of the view (default undefined). */
+    maxHeight?: number;
+
+    /** Minimum height of the view (default undefined). */
+    minHeight?: number;
+
+    /** Maximum width of the view (default undefined). */
+    maxWidth?: number
+
+    /** Minimum width of the view (default undefined). */
+    minWidth?: number
+
     /** True to hide the panel header (default false). */
     hidePanelHeader?: boolean;
 
@@ -29,4 +41,7 @@ export interface DashCanvasViewSpec extends DashViewSpec {
 
     /** True to set height automatically based on content height (default false). */
     autoHeight?: boolean;
+
+    /** True (default) to allow duplicating the view. */
+    allowDuplicate?: boolean;
 }

package/desktop/cmp/dash/canvas/impl/DashCanvasView.ts

@@ -58,7 +58,7 @@ const headerMenu = hoistCmp.factory<DashCanvasViewModel>(
     ({model}) => {
         if (model.hideMenuButton) return null;
 
-        const {viewState, viewSpec, id, containerModel, positionParams, title} = model,
+        const {allowDuplicate, viewState, viewSpec, id, containerModel, positionParams, title} = model,
             {contentLocked, renameLocked} = containerModel,
 
             addMenuItems = createViewMenuItems({
@@ -101,7 +101,7 @@ const headerMenu = hoistCmp.factory<DashCanvasViewModel>(
                     {
                         text: 'Duplicate',
                         icon: Icon.copy(),
-                        hidden: contentLocked || viewSpec.unique,
+                        hidden: !allowDuplicate || contentLocked || viewSpec.unique,
                         actionFn: () =>
                             containerModel.addViewInternal(viewSpec.id, {
                                 layout: getDuplicateLayout(positionParams, model),

package/desktop/cmp/rest/RestGridModel.ts

@@ -185,7 +185,7 @@ export class RestGridModel extends HoistModel {
     }
 
     cloneRecord(record: StoreRecord) {
-        const clone = this.store.editableDataForRecord(record as any);
+        const clone = this.store.editableDataForRecord(record);
         this.prepareCloneFn?.({record, clone});
         this.formModel.openClone(clone);
     }
@@ -247,4 +247,4 @@ export class RestGridModel extends HoistModel {
     private parseStore(store: RestStore|RestStoreConfig) {
         return store instanceof RestStore ? store : this.markManaged(new RestStore(store));
     }
-}
+}

package/desktop/cmp/rest/data/RestStore.ts

@@ -5,13 +5,9 @@
  * Copyright © 2022 Extremely Heavy Industries Inc.
  */
 import {PlainObject, XH} from '@xh/hoist/core';
-import {
-    StoreRecord,
-    UrlStore,
-    UrlStoreConfig
-} from '@xh/hoist/data';
+import {StoreRecord, StoreRecordId, UrlStore, UrlStoreConfig} from '@xh/hoist/data';
 import '@xh/hoist/desktop/register';
-import {filter, keyBy, mapValues} from 'lodash';
+import {filter, isNil, keyBy, mapValues} from 'lodash';
 import {RestField, RestFieldSpec} from './RestField';
 
 
@@ -81,17 +77,17 @@ export class RestStore extends UrlStore {
         return resp;
     }
 
-    async addRecordAsync(rec: {id: string, data: PlainObject}) {
+    async addRecordAsync(rec: {id?: StoreRecordId, data: PlainObject}) {
         return this.saveRecordInternalAsync(rec, true)
             .linkTo(this.loadModel);
     }
 
-    async saveRecordAsync(rec: {id: string, data: PlainObject}) {
+    async saveRecordAsync(rec: {id: StoreRecordId, data: PlainObject}) {
         return this.saveRecordInternalAsync(rec, false)
             .linkTo(this.loadModel);
     }
 
-    async bulkUpdateRecordsAsync(ids: string[], newParams: PlainObject) {
+    async bulkUpdateRecordsAsync(ids: StoreRecordId[], newParams: PlainObject) {
         const {url} = this,
             resp = await XH.fetchService.putJson({
                 url: `${url}/bulkUpdate`,
@@ -104,7 +100,7 @@ export class RestStore extends UrlStore {
         return resp;
     }
 
-    editableDataForRecord(record: {id: string, data: PlainObject}): PlainObject {
+    editableDataForRecord(record: {data: PlainObject}): PlainObject {
         const {data} = record,
             editable = keyBy(filter(this.fields, 'editable'), 'name');
         return mapValues(editable, (v, k) => data[k]);
@@ -117,12 +113,15 @@ export class RestStore extends UrlStore {
     //--------------------------------
     // Implementation
     //--------------------------------
-    private async saveRecordInternalAsync(rec: {id: string, data: PlainObject}, isAdd) {
-        let {url, dataRoot} = this;
-        if (!isAdd) url += '/' + rec.id;
+    private async saveRecordInternalAsync(rec: {id?: StoreRecordId, data: PlainObject}, isAdd) {
+        let {url, dataRoot} = this,
+            {id} = rec;
+
+        if (!isAdd) url += '/' + id;
 
         // Only include editable fields in the request data
-        const data = {id: rec.id, ...this.editableDataForRecord(rec)};
+        const data = this.editableDataForRecord(rec);
+        if (!isNil(id)) data.id = id;
 
         const fetchMethod = isAdd ? 'postJson' : 'putJson',
             response = await XH.fetchService[fetchMethod]({url, body: {data}}),

package/package.json

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