devexpress-reporting 23.2.6 → 24.1.2-beta

package/viewer/parameters/previewParametersModel.js

@@ -0,0 +1,41 @@
+/**
+* DevExpress HTML/JS Reporting (viewer\parameters\previewParametersModel.js)
+* Version:  24.1.2-beta
+* Build date: May 14, 2024
+* Copyright (c) 2012 - 2024 Developer Express Inc. ALL RIGHTS RESERVED
+* License: https://www.devexpress.com/Support/EULAs/universal.xml
+*/
+import { ParametersPanelModelBase } from './parametersPanelModelBase';
+import { getLocalization } from '@devexpress/analytics-core/analytics-internal-native';
+export class PreviewParametersPanelModel extends ParametersPanelModelBase {
+    constructor(reportPreview, parameterHelper, enableKeyboardSupport) {
+        super(reportPreview, parameterHelper, enableKeyboardSupport);
+        this.submit = () => {
+            if (this.parametersLoading)
+                return;
+            this.parametersLoading = true;
+            const promise = reportPreview.startBuild();
+            promise && promise.then((val) => { this.parametersLoading = false; });
+        };
+        this.buttons.push({
+            text: getLocalization('Submit', 'ASPxReportsStringId.ParametersPanel_Submit'),
+            onClick: (params) => this._validateAndSubmit(params)
+        });
+    }
+    initialize(originalParametersInfo) {
+        super.initialize(originalParametersInfo);
+        if (!originalParametersInfo || this._parametersHolder.documentId)
+            return;
+        if (!originalParametersInfo.shouldRequestParameters || this.isEmpty) {
+            this.submit();
+        }
+        else {
+            this._parametersHolder.removeEmptyPages();
+            this.tabInfo.active = true;
+            if (this.tabInfo.visible && this.tabInfo.collapsed !== undefined)
+                this.tabInfo.collapsed = false;
+            this._popupVisible = true;
+            this._parametersHolder.pageLoading = false;
+        }
+    }
+}

package/viewer/parameters/previewParametersViewModel.viewmodel.d.ts

@@ -1,20 +1,21 @@
 /**
 * DevExpress HTML/JS Reporting (viewer\parameters\previewParametersViewModel.viewmodel.d.ts)
-* Version:  23.2.6
-* Build date: Apr 30, 2024
+* Version:  24.1.2-beta
+* Build date: May 14, 2024
 * Copyright (c) 2012 - 2024 Developer Express Inc. ALL RIGHTS RESERVED
 * License: https://www.devexpress.com/Support/EULAs/universal.xml
 */
-import { IViewModel } from '@devexpress/analytics-core/analytics-serializer-native';
-import { PreviewParametersViewModel } from './previewParametersViewModel';
-import { Properties } from 'devextreme/ui/button';
-export interface IPreviewParametersViewModel extends IViewModel {
+import { IViewModel, PropertyChangedEventArgs } from '@devexpress/analytics-core/analytics-serializer-native';
+import { Properties as dxButtonProperties } from 'devextreme/ui/button';
+import { ParametersPanelModelBase } from './parametersPanelModelBase';
+export interface IParametersPanelViewModel extends IViewModel {
     headerText: string;
     emptyText: string;
     isEmpty: boolean;
     parametersLoading: boolean;
-    resetButton: Properties;
-    submitButton: Properties;
+    buttons: dxButtonProperties[];
+    showButtons: boolean;
+    showHeader: boolean;
 }
-export declare function createPreviewParametersViewModel(this: PreviewParametersViewModel, baseModel: IPreviewParametersViewModel): IPreviewParametersViewModel;
-export declare function updateViewModel(this: PreviewParametersViewModel): void;
+export declare function createPreviewParametersViewModel(this: ParametersPanelModelBase, baseModel: IParametersPanelViewModel): IParametersPanelViewModel;
+export declare function updateViewModel(this: ParametersPanelModelBase, args: PropertyChangedEventArgs<ParametersPanelModelBase>): void;

package/viewer/parameters/previewParametersViewModel.viewmodel.js

@@ -1,7 +1,7 @@
 /**
 * DevExpress HTML/JS Reporting (viewer\parameters\previewParametersViewModel.viewmodel.js)
-* Version:  23.2.6
-* Build date: Apr 30, 2024
+* Version:  24.1.2-beta
+* Build date: May 14, 2024
 * Copyright (c) 2012 - 2024 Developer Express Inc. ALL RIGHTS RESERVED
 * License: https://www.devexpress.com/Support/EULAs/universal.xml
 */
@@ -10,21 +10,21 @@ import { getLocalization } from '@devexpress/analytics-core/analytics-internal-n
 export function createPreviewParametersViewModel(baseModel) {
     return createViewModelGenerator(baseModel)
         .generateProperty('headerText', getLocalization('Preview Parameters', 'ASPxReportsStringId.ReportDesigner_Preview_ParametersTitle'))
+        .generateProperty('showHeader', this._showHeader)
         .generateProperty('emptyText', getLocalization('The report does not contain any parameters.', 'ASPxReportsStringId.WebDocumentViewer_NoParameters'))
         .generateProperty('isEmpty', this.isEmpty)
-        .generateProperty('resetButton', {
-        text: getLocalization('Reset', 'ASPxReportsStringId.ParametersPanel_Reset'),
-        onClick: (e) => this.restore()
-    })
-        .generateProperty('submitButton', {
-        text: getLocalization('Submit', 'ASPxReportsStringId.ParametersPanel_Submit'),
-        onClick: (params) => this.validateAndSubmit(params)
-    })
+        .generateProperty('buttons', this.buttons)
+        .generateProperty('showButtons', this.showButtons)
         .generateProperty('parametersLoading', this.parametersLoading)
         .getViewModel();
 }
-export function updateViewModel() {
+export function updateViewModel(args) {
     const viewModel = this.getViewModel();
     viewModel.isEmpty = this.isEmpty;
     viewModel.parametersLoading = this.parametersLoading;
+    viewModel.showHeader = this._showHeader;
+    viewModel.showButtons = this.showButtons;
+    if (args.propertyName === 'buttons') {
+        viewModel.buttons = [].concat(this.buttons);
+    }
 }

package/viewer/reportHolder.d.ts

@@ -0,0 +1,39 @@
+/**
+* DevExpress HTML/JS Reporting (viewer\reportHolder.d.ts)
+* Version:  24.1.2-beta
+* Build date: May 14, 2024
+* Copyright (c) 2012 - 2024 Developer Express Inc. ALL RIGHTS RESERVED
+* License: https://www.devexpress.com/Support/EULAs/universal.xml
+*/
+/// <reference types="jquery" />
+import { DxDeferred } from '@devexpress/analytics-core/analytics-internal-native';
+import { ArrayPropertyChangedEventArgs, BaseRenderingModel, PropertyChangedEventArgs } from '@devexpress/analytics-core/analytics-serializer-native';
+import { PreviewRequestWrapper } from './internal/_previewRequestWrapper';
+import { IReportParametersInfo, ParametersPanelModelBase } from './parameters/parametersPanelModelBase';
+import { IReportPreviewViewModel } from './reportPreview.viewModel';
+import { IPreviewInitialize } from './utils/initializer';
+export declare class ReportHolder extends BaseRenderingModel<IReportPreviewViewModel> {
+    protected element?: Element;
+    private _initializeDataPromise;
+    private _openReportOperationDeferred;
+    protected _deferreds: DxDeferred<any>[];
+    protected _clearReportInfo(): void;
+    constructor(handlerUri?: string, previewRequestWrapper?: PreviewRequestWrapper, element?: Element);
+    onPropertyChanged(args: PropertyChangedEventArgs<ReportHolder> | ArrayPropertyChangedEventArgs<ReportHolder>): void;
+    dispose(): void;
+    closeReport(): void;
+    deactivate(): void;
+    openReport(reportName: string): PromiseLike<IPreviewInitialize>;
+    initialize(initializeDataPromise: PromiseLike<IPreviewInitialize>): PromiseLike<IPreviewInitialize>;
+    _getErrorMessage(jqXHR: JQuery.jqXHR): string;
+    _processError(error: string, jqXHR?: JQuery.jqXHR, showForUser?: boolean, serverError?: string): void;
+    _getToastMessageContainer(): Element;
+    originalParametersInfo: IReportParametersInfo;
+    reportId: string;
+    reportUrl: string;
+    previewParametersViewModel: ParametersPanelModelBase;
+    requestWrapper: PreviewRequestWrapper;
+    _closeReportRequests: {
+        [key: string]: boolean;
+    };
+}

package/viewer/reportHolder.js

@@ -0,0 +1,106 @@
+/**
+* DevExpress HTML/JS Reporting (viewer\reportHolder.js)
+* Version:  24.1.2-beta
+* Build date: May 14, 2024
+* Copyright (c) 2012 - 2024 Developer Express Inc. ALL RIGHTS RESERVED
+* License: https://www.devexpress.com/Support/EULAs/universal.xml
+*/
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+import { DxDeferred, getErrorMessage, _addLicenseTrigger } from '@devexpress/analytics-core/analytics-internal-native';
+import { BaseRenderingModel, mutable } from '@devexpress/analytics-core/analytics-serializer-native';
+import { HandlerUri, MessageHandler } from './settings';
+export class ReportHolder extends BaseRenderingModel {
+    _clearReportInfo() {
+        this.closeReport();
+        this.originalParametersInfo = null;
+    }
+    constructor(handlerUri, previewRequestWrapper, element) {
+        super();
+        this.element = element;
+        this._deferreds = [];
+        this._closeReportRequests = {};
+        HandlerUri(handlerUri || HandlerUri());
+        this.requestWrapper = previewRequestWrapper;
+    }
+    onPropertyChanged(args) { }
+    dispose() {
+        super.dispose();
+        (this._deferreds || []).forEach(deferred => deferred.reject());
+    }
+    closeReport() {
+        this._openReportOperationDeferred && this._openReportOperationDeferred.reject();
+        this._initializeDataPromise = null;
+        const currentReportId = this.reportId;
+        if (!currentReportId) {
+            return;
+        }
+        this._closeReportRequests[currentReportId] = true;
+        this.requestWrapper.sendCloseRequest(null, currentReportId);
+    }
+    deactivate() {
+        this.closeReport();
+        this.reportId = null;
+        this.reportUrl = null;
+        this.originalParametersInfo = null;
+    }
+    openReport(reportName) {
+        this._clearReportInfo();
+        const deferred = new DxDeferred();
+        this._deferreds.push(deferred);
+        this._openReportOperationDeferred = deferred;
+        this.requestWrapper.openReport(reportName).done((response) => {
+            deferred.resolve(response);
+        }).fail((error) => {
+            deferred.reject(error);
+        });
+        return this.initialize(deferred.promise());
+    }
+    initialize(initializeDataPromise) {
+        this.reportId = null;
+        this.reportUrl = null;
+        this._initializeDataPromise = initializeDataPromise;
+        initializeDataPromise.then((previewInitialize) => {
+            if (this._initializeDataPromise !== initializeDataPromise)
+                return;
+            _addLicenseTrigger(previewInitialize === null || previewInitialize === void 0 ? void 0 : previewInitialize._licenseOptions);
+            if (previewInitialize && !previewInitialize.error && !previewInitialize.startBuildFaultMessage && (previewInitialize.reportId || previewInitialize.documentId)) {
+                this.reportId = previewInitialize.reportId;
+                this.reportUrl = previewInitialize.reportUrl;
+                this.originalParametersInfo = previewInitialize.parametersInfo;
+            }
+        });
+        return initializeDataPromise;
+    }
+    _getErrorMessage(jqXHR) {
+        const serverError = getErrorMessage(jqXHR);
+        if (!serverError)
+            return jqXHR && jqXHR.responseJSON && jqXHR.responseJSON.result && jqXHR.responseJSON.result.faultMessage ?
+                jqXHR.responseJSON.result.faultMessage :
+                serverError;
+        return serverError;
+    }
+    _processError(error, jqXHR, showForUser = true, serverError) {
+        const prefix = error + ': ';
+        serverError = serverError || this._getErrorMessage(jqXHR);
+        serverError && (error = prefix + serverError);
+        MessageHandler().processError(error, showForUser, serverError && prefix, this._getToastMessageContainer());
+    }
+    _getToastMessageContainer() {
+        var _a;
+        return (_a = this.element) === null || _a === void 0 ? void 0 : _a.getElementsByClassName('dx-designer-viewport')[0];
+    }
+}
+__decorate([
+    mutable(null)
+], ReportHolder.prototype, "originalParametersInfo", void 0);
+__decorate([
+    mutable(null)
+], ReportHolder.prototype, "reportId", void 0);
+__decorate([
+    mutable(null)
+], ReportHolder.prototype, "reportUrl", void 0);

package/viewer/reportPreview.d.ts

@@ -1,12 +1,12 @@
 /**
 * DevExpress HTML/JS Reporting (viewer\reportPreview.d.ts)
-* Version:  23.2.6
-* Build date: Apr 30, 2024
+* Version:  24.1.2-beta
+* Build date: May 14, 2024
 * Copyright (c) 2012 - 2024 Developer Express Inc. ALL RIGHTS RESERVED
 * License: https://www.devexpress.com/Support/EULAs/universal.xml
 */
-/// <reference types="jquery" />
-import { ArrayPropertyChangedEventArgs, BaseRenderingModel, PropertyChangedEventArgs } from '@devexpress/analytics-core/analytics-serializer-native';
+import { DxPromise } from '@devexpress/analytics-core/analytics-internal-native';
+import { ArrayPropertyChangedEventArgs, PropertyChangedEventArgs } from '@devexpress/analytics-core/analytics-serializer-native';
 import { TabPanel } from '@devexpress/analytics-core/analytics-utils-native';
 import { PreviewBricksKeyboardHelper } from './accessibility/_previewBricksKeyboardHelper';
 import { ZoomAutoBy } from './constants';
@@ -20,14 +20,15 @@ import { PageLoader } from './internal/_pageLoader';
 import { IDocumentBuildStatus, PreviewHandlersHelper } from './internal/_previewHandlersHelper';
 import { ISignatureDisplayItem, PreviewRequestWrapper } from './internal/_previewRequestWrapper';
 import { IProgressHandler } from './internal/_progressViewModel';
-import { IReportParametersInfo, PreviewParametersViewModel } from './parameters/previewParametersViewModel';
+import { IReportParametersInfo } from './parameters/parametersPanelModelBase';
 import { IReportPreviewViewModel } from './reportPreview.viewModel';
 import { IExportSettings, IPreviewCustomizationHandler, IPreviewExportOptionsCustomizationArgs, IPreviewInitialize } from './utils/initializer';
 import { IBrickNode, IBrickNodeNavigation, IDocumentOperationResult } from './utils/utils';
 import { BreadcrumbModel } from './internal/_previewBreadcrumbs';
-export declare class ReportPreview extends BaseRenderingModel<IReportPreviewViewModel> {
+import { PreviewParametersPanelModel } from './parameters/previewParametersModel';
+import { ReportHolder } from './reportHolder';
+export declare class ReportPreview extends ReportHolder {
     private enableKeyboardSupport?;
-    private element?;
     predefinedZoomLevels: number[];
     _stopBuildRequests: {
         [key: string]: boolean;
@@ -42,7 +43,6 @@ export declare class ReportPreview extends BaseRenderingModel<IReportPreviewView
         [key: string]: boolean;
     };
     _breadcrumb: BreadcrumbModel;
-    private _openReportOperationDeferred;
     _startBuildOperationId: string;
     private _drillDownState;
     private _sortingState;
@@ -52,7 +52,6 @@ export declare class ReportPreview extends BaseRenderingModel<IReportPreviewView
     private _onGetDocumentDetails;
     private _initialDocumentData;
     private _timeouts;
-    private _deferreds;
     private _doDrillDown;
     private _doSorting;
     dispose(): void;
@@ -67,30 +66,28 @@ export declare class ReportPreview extends BaseRenderingModel<IReportPreviewView
     createPage(pageIndex: number, processClick?: (target: IBrickNode) => void, subscribeToPageLoading?: boolean): PreviewPage;
     private _getIgnorePredicate;
     private _cleanTabInfo;
-    private _clearReportInfo;
+    protected _clearReportInfo(): void;
     createBrickClickProcessor(cyclePageIndex: number): (brick: IBrickNode, e?: JQueryEventObject) => void;
     constructor(handlerUri?: string, previewRequestWrapper?: PreviewRequestWrapper, previewHandlersHelper?: PreviewHandlersHelper, callbacks?: IPreviewCustomizationHandler, rtl?: boolean, enableKeyboardSupport?: boolean, exportSettings?: IExportSettings, element?: Element, breadcrumb?: BreadcrumbModel);
     delayedInit(): void;
-    openReport(reportName: string): JQueryPromise<IPreviewInitialize>;
-    goToReport(customData?: string, closeCurrentReport?: boolean): JQueryPromise<IPreviewInitialize>;
-    drillThrough(drillThroughData: string): JQueryPromise<IPreviewInitialize>;
+    goToReport(customData?: string, closeCurrentReport?: boolean): PromiseLike<IPreviewInitialize>;
+    drillThrough(drillThroughData: string): PromiseLike<IPreviewInitialize>;
     _sortCustomParametersLookUpValues(reportParameterInfo?: IReportParametersInfo): void;
     _resolveFirstPage(status: IDocumentBuildStatus): void;
-    initialize(initializeDataPromise: JQueryPromise<IPreviewInitialize>, closeDocument?: boolean): JQueryPromise<IPreviewInitialize>;
+    initialize(initializeDataPromise: PromiseLike<IPreviewInitialize>, closeDocument?: boolean): PromiseLike<IPreviewInitialize>;
     private _deserializeExportOptions;
     deactivate(): void;
-    startBuild(): JQuery.Promise<boolean>;
-    customDocumentOperation(customData?: string, hideMessageFromUser?: boolean): JQueryPromise<IDocumentOperationResult>;
-    _initializeStartBuild(documentIdPromise: JQueryPromise<string>): boolean;
-    _startBuildRequest(): JQuery.Promise<boolean>;
-    getBuildStatus(documentId: string, isFirstRequest: boolean, shouldRequestFirstPage: boolean): JQueryPromise<IDocumentBuildStatus>;
+    startBuild(): PromiseLike<boolean>;
+    customDocumentOperation(customData?: string, hideMessageFromUser?: boolean): Promise<IDocumentOperationResult>;
+    _initializeStartBuild(documentIdPromise: DxPromise<string>): boolean;
+    _startBuildRequest(): PromiseLike<boolean>;
+    getBuildStatus(documentId: string, isFirstRequest: boolean, shouldRequestFirstPage: boolean): PromiseLike<IDocumentBuildStatus>;
     getDoGetBuildStatusFunc(shouldRequestFirstPage?: boolean): (documentId: string) => void;
     getDocumentData(documentId: string): void;
     exportDocumentTo(format: string, inlineResult?: boolean): void;
     printDocument(pageIndex?: number): void;
     stopBuild(documentId?: string): void;
     closeDocument(documentId?: string): void;
-    closeReport(): void;
     setPageVisibility(page: PreviewPage, visible: boolean): void;
     updatePage(page: PreviewPage, zoom?: number): void;
     goToPage(pageIndex: number, forcePageChanging?: boolean, throttle?: number): void;
@@ -100,7 +97,6 @@ export declare class ReportPreview extends BaseRenderingModel<IReportPreviewView
     rtlViewer: boolean;
     exportHandler: ExportHandler;
     previewHandlersHelper: PreviewHandlersHelper;
-    originalParametersInfo: IReportParametersInfo;
     exportOptionsModel: ExportOptionsPreview;
     errorMessage: string;
     reportOpening: boolean;
@@ -127,8 +123,6 @@ export declare class ReportPreview extends BaseRenderingModel<IReportPreviewView
     zoom: number;
     previewSize: number;
     documentId: string;
-    reportId: string;
-    reportUrl: string;
     documentBuilding: boolean;
     _unifier: string;
     _pageWidth: number;
@@ -142,20 +136,16 @@ export declare class ReportPreview extends BaseRenderingModel<IReportPreviewView
     createViewModel(): IReportPreviewViewModel;
     updateViewModel(args: PropertyChangedEventArgs<ReportPreview> | ArrayPropertyChangedEventArgs<ReportPreview>): void;
     editingFieldsProvider: () => EditingField[];
-    _getErrorMessage(jqXHR: JQuery.jqXHR): string;
-    _processError(error: string, jqXHR?: JQuery.jqXHR, showForUser?: boolean, serverError?: string): void;
-    _getToastMessageContainer(): Element;
     _raiseOnSizeChanged: () => void;
     _loadVisibleImages: (timeout?: number) => void;
     _getPagesViewModels: () => IPreviewPageViewModel[];
     canSwitchToDesigner: boolean;
     allowURLsWithJSContent: boolean;
-    requestWrapper: PreviewRequestWrapper;
     zoomStep: number;
     private _progressFirstTime;
     private _updateEmptyDocumentCaption;
     signatures: ISignatureDisplayItem[];
-    previewParametersViewModel: PreviewParametersViewModel;
+    previewParametersViewModel: PreviewParametersPanelModel;
     previewBrickKeyboardHelper: PreviewBricksKeyboardHelper;
     pageLoader: PageLoader;
 }