@xh/hoist 70.0.0-SNAPSHOT.1731083521069 → 70.0.0-SNAPSHOT.1731623470295

package/build/types/cmp/grid/impl/GridPersistenceModel.d.ts

@@ -1,41 +0,0 @@
-import { GridSorterLike } from '@xh/hoist/cmp/grid';
-import { HoistModel, PersistenceProvider, Some } from '@xh/hoist/core';
-import { GridModel } from '../GridModel';
-import { ColumnState, GridModelPersistOptions } from '../Types';
-/**
- * Model to manage persisting state from GridModel.
- * @internal
- */
-export declare class GridPersistenceModel extends HoistModel {
-    xhImpl: boolean;
-    VERSION: number;
-    gridModel: GridModel;
-    state: {
-        columns?: Partial<ColumnState>[];
-        sortBy?: Some<GridSorterLike>;
-        groupBy?: Some<string>;
-        version?: number;
-        autosize?: any;
-    };
-    provider: PersistenceProvider;
-    constructor(gridModel: GridModel, { persistColumns, persistGrouping, persistSort, ...persistWith }: GridModelPersistOptions);
-    clear(): void;
-    columnReaction(): {
-        track: () => (import("@xh/hoist/cmp/grid").AutosizeState | ColumnState[])[];
-        run: ([columnState, autosizeState]: [any, any]) => void;
-    };
-    updateGridColumns(): void;
-    sortReaction(): {
-        track: () => import("@xh/hoist/cmp/grid").GridSorter[];
-        run: (sortBy: any) => void;
-    };
-    updateGridSort(): void;
-    groupReaction(): {
-        track: () => string[];
-        run: (groupBy: any) => void;
-    };
-    updateGridGroupBy(): void;
-    patchState(updates: any): void;
-    loadState(): any;
-    legacyState(): any;
-}

package/build/types/cmp/zoneGrid/impl/ZoneGridPersistenceModel.d.ts

@@ -1,39 +0,0 @@
-import { GridSorterLike } from '@xh/hoist/cmp/grid';
-import { HoistModel, PersistenceProvider, Some } from '@xh/hoist/core';
-import { ZoneGridModel } from '../ZoneGridModel';
-import { Zone, ZoneGridModelPersistOptions, ZoneMapping } from '../Types';
-/**
- * Model to manage persisting state from ZoneGridModel.
- * @internal
- */
-export declare class ZoneGridPersistenceModel extends HoistModel {
-    xhImpl: boolean;
-    VERSION: number;
-    zoneGridModel: ZoneGridModel;
-    state: {
-        sortBy?: GridSorterLike;
-        groupBy?: Some<string>;
-        version?: number;
-        mappings?: Record<Zone, Some<string | ZoneMapping>>;
-    };
-    provider: PersistenceProvider;
-    constructor(zoneGridModel: ZoneGridModel, config: ZoneGridModelPersistOptions);
-    clear(): void;
-    mappingReaction(): {
-        track: () => Record<Zone, ZoneMapping[]>;
-        run: (mappings: any) => void;
-    };
-    updateGridMapping(): void;
-    sortReaction(): {
-        track: () => import("@xh/hoist/cmp/grid").GridSorter;
-        run: (sortBy: any) => void;
-    };
-    updateGridSort(): void;
-    groupReaction(): {
-        track: () => string[];
-        run: (groupBy: any) => void;
-    };
-    updateGridGroupBy(): void;
-    patchState(updates: any): void;
-    loadState(): any;
-}

package/cmp/grid/impl/GridPersistenceModel.ts

@@ -1,174 +0,0 @@
-/*
- * This file belongs to Hoist, an application development toolkit
- * developed by Extremely Heavy Industries (www.xh.io | info@xh.io)
- *
- * Copyright © 2024 Extremely Heavy Industries Inc.
- */
-import {GridSorterLike} from '@xh/hoist/cmp/grid';
-import {HoistModel, managed, PersistenceProvider, Some, XH} from '@xh/hoist/core';
-import {action, makeObservable, observable} from '@xh/hoist/mobx';
-import {isUndefined} from 'lodash';
-import {GridModel} from '../GridModel';
-import {ColumnState, GridModelPersistOptions} from '../Types';
-
-/**
- * Model to manage persisting state from GridModel.
- * @internal
- */
-export class GridPersistenceModel extends HoistModel {
-    override xhImpl = true;
-
-    VERSION = 1; // Increment to abandon state.
-
-    gridModel: GridModel;
-
-    @observable.ref
-    state: {
-        columns?: Partial<ColumnState>[];
-        sortBy?: Some<GridSorterLike>;
-        groupBy?: Some<string>;
-        version?: number;
-        autosize?: any;
-    };
-
-    @managed
-    provider: PersistenceProvider;
-
-    constructor(
-        gridModel: GridModel,
-        {
-            persistColumns = true,
-            persistGrouping = true,
-            persistSort = true,
-            ...persistWith
-        }: GridModelPersistOptions
-    ) {
-        super();
-        makeObservable(this);
-        this.gridModel = gridModel;
-
-        persistWith = {path: 'grid', ...persistWith};
-
-        // 1) Read state from and attach to provider -- fail gently
-        try {
-            this.provider = PersistenceProvider.create(persistWith);
-            this.state = this.loadState() ?? this.legacyState() ?? {version: this.VERSION};
-            this.addReaction({
-                track: () => this.state,
-                run: state => this.provider.write(state)
-            });
-        } catch (e) {
-            this.logError(e);
-            this.state = {version: this.VERSION};
-        }
-
-        // 2) Bind self to grid, and populate grid.
-        if (persistColumns) {
-            this.updateGridColumns();
-            this.addReaction(this.columnReaction());
-        }
-
-        if (persistGrouping) {
-            this.updateGridGroupBy();
-            this.addReaction(this.groupReaction());
-        }
-
-        if (persistSort) {
-            this.updateGridSort();
-            this.addReaction(this.sortReaction());
-        }
-    }
-
-    @action
-    clear() {
-        this.state = {version: this.VERSION};
-    }
-
-    //--------------------------
-    // Columns
-    //--------------------------
-    columnReaction() {
-        const {gridModel} = this;
-        return {
-            track: () => [gridModel.columnState, gridModel.autosizeState],
-            run: ([columnState, autosizeState]) => {
-                this.patchState({
-                    columns: gridModel.cleanColumnState(columnState),
-                    autosize: autosizeState
-                });
-            }
-        };
-    }
-
-    updateGridColumns() {
-        const {columns, autosize} = this.state;
-        if (!isUndefined(columns)) this.gridModel.setColumnState(columns);
-        if (!isUndefined(autosize)) this.gridModel.setAutosizeState(autosize);
-    }
-
-    //--------------------------
-    // Sort
-    //--------------------------
-    sortReaction() {
-        return {
-            track: () => this.gridModel.sortBy,
-            run: sortBy => {
-                this.patchState({sortBy: sortBy.map(it => it.toString())});
-            }
-        };
-    }
-
-    updateGridSort() {
-        const {sortBy} = this.state;
-        if (!isUndefined(sortBy)) this.gridModel.setSortBy(sortBy);
-    }
-
-    //--------------------------
-    // Grouping
-    //--------------------------
-    groupReaction() {
-        return {
-            track: () => this.gridModel.groupBy,
-            run: groupBy => {
-                this.patchState({groupBy});
-            }
-        };
-    }
-
-    updateGridGroupBy() {
-        const {groupBy} = this.state;
-        if (!isUndefined(groupBy)) this.gridModel.setGroupBy(groupBy);
-    }
-
-    //--------------------------
-    // Other Implementation
-    //--------------------------
-    @action
-    patchState(updates) {
-        this.state = {...this.state, ...updates};
-    }
-
-    loadState() {
-        const ret = this.provider.read();
-        return ret?.version === this.VERSION ? ret : null;
-    }
-
-    legacyState() {
-        const {VERSION} = this,
-            provider = this.provider as any;
-        if (VERSION === 1) {
-            let legacyKey = provider.legacyStateKey ?? provider.key;
-            if (legacyKey) {
-                legacyKey = 'gridState.v1.' + legacyKey;
-                let data = XH.localStorageService.get(legacyKey);
-                if (data) {
-                    data = {...data, version: VERSION};
-                    provider.write(data);
-                    XH.localStorageService.remove(legacyKey);
-                    return data;
-                }
-            }
-        }
-        return null;
-    }
-}

package/cmp/zoneGrid/impl/ZoneGridPersistenceModel.ts

@@ -1,149 +0,0 @@
-/*
- * This file belongs to Hoist, an application development toolkit
- * developed by Extremely Heavy Industries (www.xh.io | info@xh.io)
- *
- * Copyright © 2024 Extremely Heavy Industries Inc.
- */
-import {GridSorterLike} from '@xh/hoist/cmp/grid';
-import {HoistModel, managed, PersistenceProvider, Some} from '@xh/hoist/core';
-import {action, makeObservable, observable} from '@xh/hoist/mobx';
-import {isUndefined} from 'lodash';
-import {ZoneGridModel} from '../ZoneGridModel';
-import {Zone, ZoneGridModelPersistOptions, ZoneMapping} from '../Types';
-
-/**
- * Model to manage persisting state from ZoneGridModel.
- * @internal
- */
-export class ZoneGridPersistenceModel extends HoistModel {
-    override xhImpl = true;
-
-    VERSION = 1; // Increment to abandon state.
-
-    zoneGridModel: ZoneGridModel;
-
-    @observable.ref
-    state: {
-        sortBy?: GridSorterLike;
-        groupBy?: Some<string>;
-        version?: number;
-        mappings?: Record<Zone, Some<string | ZoneMapping>>;
-    };
-
-    @managed
-    provider: PersistenceProvider;
-
-    constructor(zoneGridModel: ZoneGridModel, config: ZoneGridModelPersistOptions) {
-        super();
-        makeObservable(this);
-
-        this.zoneGridModel = zoneGridModel;
-
-        let {
-            persistMapping = true,
-            persistGrouping = true,
-            persistSort = true,
-            ...persistWith
-        } = config;
-
-        persistWith = {path: 'zoneGrid', ...persistWith};
-
-        // 1) Read state from and attach to provider -- fail gently
-        try {
-            this.provider = PersistenceProvider.create(persistWith);
-            this.state = this.loadState() ?? {version: this.VERSION};
-            this.addReaction({
-                track: () => this.state,
-                run: state => this.provider.write(state)
-            });
-        } catch (e) {
-            this.logError(e);
-            this.state = {version: this.VERSION};
-        }
-
-        // 2) Bind self to grid, and populate grid.
-        if (persistMapping) {
-            this.updateGridMapping();
-            this.addReaction(this.mappingReaction());
-        }
-
-        if (persistGrouping) {
-            this.updateGridGroupBy();
-            this.addReaction(this.groupReaction());
-        }
-
-        if (persistSort) {
-            this.updateGridSort();
-            this.addReaction(this.sortReaction());
-        }
-    }
-
-    @action
-    clear() {
-        this.state = {version: this.VERSION};
-    }
-
-    //--------------------------
-    // Columns
-    //--------------------------
-    mappingReaction() {
-        return {
-            track: () => this.zoneGridModel.mappings,
-            run: mappings => {
-                this.patchState({mappings});
-            }
-        };
-    }
-
-    updateGridMapping() {
-        const {mappings} = this.state;
-        if (!isUndefined(mappings)) this.zoneGridModel.setMappings(mappings);
-    }
-
-    //--------------------------
-    // Sort
-    //--------------------------
-    sortReaction() {
-        return {
-            track: () => this.zoneGridModel.sortBy,
-            run: sortBy => {
-                this.patchState({sortBy: sortBy?.toString()});
-            }
-        };
-    }
-
-    updateGridSort() {
-        const {sortBy} = this.state;
-        if (!isUndefined(sortBy)) this.zoneGridModel.setSortBy(sortBy);
-    }
-
-    //--------------------------
-    // Grouping
-    //--------------------------
-    groupReaction() {
-        return {
-            track: () => this.zoneGridModel.groupBy,
-            run: groupBy => {
-                this.patchState({groupBy});
-            }
-        };
-    }
-
-    updateGridGroupBy() {
-        const {groupBy} = this.state;
-        if (!isUndefined(groupBy)) this.zoneGridModel.setGroupBy(groupBy);
-    }
-
-    //--------------------------
-    // Other Implementation
-    //--------------------------
-    @action
-    patchState(updates) {
-        this.state = {...this.state, ...updates};
-    }
-
-    loadState() {
-        const ret = this.provider.read();
-        return ret?.version === this.VERSION ? ret : null;
-    }
-}