@xh/hoist 71.0.0-SNAPSHOT.1733262000771 → 71.0.0-SNAPSHOT.1733347475493

package/cmp/viewmanager/SaveAsDialogModel.ts

@@ -0,0 +1,97 @@
+/*
+ * 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 {FormModel} from '@xh/hoist/cmp/form';
+import {HoistModel, managed, XH} from '@xh/hoist/core';
+import {makeObservable, action, observable} from '@xh/hoist/mobx';
+import {View} from './View';
+import {ViewManagerModel} from './ViewManagerModel';
+
+/**
+ * Backing model for ViewManagerModel's SaveAs
+ */
+export class SaveAsDialogModel extends HoistModel {
+    readonly parent: ViewManagerModel;
+
+    @managed readonly formModel: FormModel;
+    @observable isOpen: boolean = false;
+
+    private resolveOpen: (value: View) => void;
+
+    get type(): string {
+        return this.parent.viewType;
+    }
+
+    get typeDisplayName(): string {
+        return this.parent.typeDisplayName;
+    }
+
+    get globalDisplayName(): string {
+        return this.parent.globalDisplayName;
+    }
+
+    constructor(parent: ViewManagerModel) {
+        super();
+        makeObservable(this);
+        this.parent = parent;
+        this.formModel = this.createFormModel();
+    }
+
+    @action
+    openAsync(): Promise<View> {
+        this.formModel.init(this.parent.view.info ?? {});
+        this.isOpen = true;
+
+        return new Promise(resolve => (this.resolveOpen = resolve));
+    }
+
+    cancel() {
+        this.close();
+        this.resolveOpen(null);
+    }
+
+    async saveAsAsync() {
+        return this.doSaveAsAsync().linkTo(this.parent.saveTask);
+    }
+
+    //------------------------
+    // Implementation
+    //------------------------
+    private createFormModel(): FormModel {
+        return new FormModel({
+            fields: [
+                {
+                    name: 'name',
+                    rules: [({value}) => this.parent.validateViewNameAsync(value)]
+                },
+                {name: 'description'}
+            ]
+        });
+    }
+
+    private async doSaveAsAsync() {
+        const {formModel, parent} = this,
+            {name, description} = formModel.getData(),
+            isValid = await formModel.validateAsync();
+
+        if (!isValid) return;
+
+        try {
+            const ret = await this.parent.createViewAsync(name, description, parent.getValue());
+            this.close();
+            this.resolveOpen(ret);
+        } catch (e) {
+            XH.handleException(e);
+        }
+    }
+
+    @action
+    private close() {
+        this.isOpen = false;
+        this.formModel.init();
+    }
+}

package/cmp/viewmanager/View.ts

@@ -0,0 +1,56 @@
+import {PlainObject} from '@xh/hoist/core';
+import {ViewManagerModel} from './ViewManagerModel';
+import {ViewInfo} from './ViewInfo';
+import {JsonBlob} from '@xh/hoist/svc';
+
+/**
+ * A named saved bundle of state for components.
+ */
+export class View<T extends PlainObject = PlainObject> {
+    /**
+     * Default View representing code state of all contained components.
+     * Available for all view managers where `enableDefault` is true.
+     */
+
+    /** Metadata about this View. Null for 'default' view */
+    readonly info: ViewInfo;
+
+    /**
+     * State for the components in the view. Only state that differs from the initial "code"
+     * state of the components is captured.
+     */
+    readonly value: Partial<T> = null;
+
+    get isDefault(): boolean {
+        return !this.info;
+    }
+
+    get isGlobal(): boolean {
+        return this.info?.isGlobal ?? false;
+    }
+
+    get lastUpdated(): number {
+        return this.info?.lastUpdated ?? null;
+    }
+
+    get token(): string {
+        return this.info?.token ?? null;
+    }
+
+    static fromBlob<T>(blob: JsonBlob, model: ViewManagerModel): View<T> {
+        return new View(new ViewInfo(blob, model), blob.value);
+    }
+
+    static createDefault<T>(): View<T> {
+        return new View(null, {});
+    }
+
+    withUpdatedValue(value: Partial<T>): View<T> {
+        return new View(this.info, value);
+    }
+
+    constructor(info: ViewInfo, value: Partial<T>) {
+        this.info = info;
+        this.value = value;
+    }
+}

package/cmp/viewmanager/ViewInfo.ts

@@ -0,0 +1,58 @@
+import {SECONDS} from '@xh/hoist/utils/datetime';
+import {ViewManagerModel} from './ViewManagerModel';
+import {JsonBlob} from '@xh/hoist/svc';
+
+/**
+ * Metadata describing {@link View} managed by {@link ViewManagerModel}.
+ */
+export class ViewInfo {
+    /** Unique Id */
+    readonly token: string;
+
+    /** App-defined type discriminator, as per {@link ViewManagerConfig.viewType}. */
+    readonly type: string;
+
+    /** User-supplied descriptive name. */
+    readonly name: string;
+
+    /** Description of the view. **/
+    readonly description: string;
+
+    /** True if this view is global and visible to all users. */
+    readonly isGlobal: boolean;
+
+    /** Original creator of the view, and the only user with access to it if not global. */
+    readonly owner: string;
+
+    dateCreated: number;
+    lastUpdated: number;
+    lastUpdatedBy: string;
+
+    private readonly model: ViewManagerModel;
+
+    constructor(blob: JsonBlob, model: ViewManagerModel) {
+        this.token = blob.token;
+        this.type = blob.type;
+        this.owner = blob.owner;
+        this.name = blob.name;
+        this.description = blob.description;
+        this.isGlobal = blob.acl === '*';
+        // Round to seconds.  See: https://github.com/xh/hoist-core/issues/423
+        this.dateCreated = Math.round(blob.dateCreated / SECONDS) * SECONDS;
+        this.lastUpdated = Math.round(blob.lastUpdated / SECONDS) * SECONDS;
+        this.lastUpdatedBy = blob.lastUpdatedBy;
+        this.model = model;
+    }
+
+    /**
+     * True if user has tagged this view as a favorite. Note that a user's list of favorite views
+     * is persisted via `ViewManagerModel.persistWith` and *not* stored in the blob itself.
+     */
+    get isFavorite(): boolean {
+        return this.model.isFavorite(this.token);
+    }
+
+    get typedName(): string {
+        return `${this.model.typeDisplayName} '${this.name}'`;
+    }
+}