@progress/telerik-jquery-report-viewer 27.25.1001 → 28.25.1111

package/README.md

@@ -18,7 +18,7 @@ Major features:
 
 * Use the viewer's API for customizing and extending its behavior.
 
-This version of Telerik jQuery Report Viewer requires either Telerik Report Server or Telerik Reporting REST Service 19.2.25.1001.
+This version of Telerik jQuery Report Viewer requires either Telerik Report Server or Telerik Reporting REST Service 19.3.25.1111.
 
 Learn more about Telerik Reporting Viewers here: [Telerik Report Viewers Overview](https://docs.telerik.com/reporting/embedding-reports/display-reports-in-applications/overview)
 

package/dist/cjs/reportViewer.js

@@ -148,14 +148,12 @@ function ReportViewer(dom, options) {
   var history$1 = {};
   var commands = {};
   var viewer = {};
-  var serviceClientOptions = {};
-  var reportServerUrl = "";
   options.viewerSelector = "reportViewer-" + utils.generateGuidString();
   $placeholder.attr("data-selector", options.viewerSelector);
   if (!validateOptions(options)) {
     return;
   }
-  var version = "19.2.25.1001";
+  var version = "19.3.25.1111";
   options = $.extend({}, getDefaultOptions(svcApiUrl, version), options);
   settings = new reportViewerSettings.ReportViewerSettings(
     persistanceKey,
@@ -175,20 +173,7 @@ function ReportViewer(dom, options) {
     }
   );
   notificationService$1 = new notificationService.NotificationService();
-  if (options.reportServer) {
-    reportServerUrl = utils.rTrim(options.reportServer.url, "\\/");
-    var serviceUrl = reportServerUrl + "/api/reports";
-    var tokenUrl = reportServerUrl + "/Token";
-    var loginInfo = new RCV__namespace.ServiceClientLoginInfo(
-      tokenUrl,
-      options.reportServer.username,
-      options.reportServer.password
-    );
-    serviceClientOptions = new RCV__namespace.ServiceClientOptions(serviceUrl, loginInfo);
-  } else {
-    serviceClientOptions = new RCV__namespace.ServiceClientOptions(options.serviceUrl);
-  }
-  client = new RCV__namespace.ServiceClient(serviceClientOptions);
+  client = new RCV__namespace.ServiceClient(options);
   controller = new RCV__namespace.ReportController(
     client,
     new RCV__namespace.ReportControllerOptions(
@@ -221,7 +206,25 @@ function ReportViewer(dom, options) {
     commands
   });
   viewer = {
+    /**
+     * String resources used by the viewer for localization and UI text.
+     * Contains key-value pairs for all UI strings, supporting localization and customization.
+     * @type {Object.<string, string>}
+     */
     stringResources: stringResources.stringResources,
+    /**
+     * Refreshes the currently loaded report.
+     * Forces the viewer to reload the report from the server. Optionally ignores the cache.
+     * @function
+     * @param {boolean} [ignoreCache=true] - If true, the report is reloaded from the server, bypassing any cached data.
+     * @returns {ReportViewerInstance} Returns the viewer instance for chaining.
+     * @example // Refresh the report, ignoring cache (default)
+     * var viewer = $("#reportViewer1").data("telerik_ReportViewer");
+     * viewer.refreshReport();
+     * @example // Refresh the report, using cache if available
+     * var viewer = $("#reportViewer1").data("telerik_ReportViewer");
+     * viewer.refreshReport(false);
+     */
     refreshReport: (ignoreCache) => {
       if (arguments.length === 0) {
         ignoreCache = true;
@@ -229,6 +232,26 @@ function ReportViewer(dom, options) {
       controller.refreshReport(ignoreCache, "", true);
       return viewer;
     },
+    /**
+     * Gets or sets the report source for the viewer.
+     * When called with an argument, sets the report source
+     * When called without arguments, gets the current report source - report and parameters. The viewer's report source is updated dynamically as the users navigate between reports and change parameter values.
+     * @function
+     * @param {ReportSource|null} [rs] - The report source object to set, or null to clear. If omitted, acts as a getter.
+     * @returns {ReportSource} Returns the viewer instance for chaining when setting, or the current report source when getting.
+     * @example // Get the current report source
+     * var viewer = $("#reportViewer1").data("telerik_ReportViewer");
+     * var currentSource = viewer.reportSource();
+     * @example // Set a new report source
+     * var viewer = $("#reportViewer1").data("telerik_ReportViewer");
+     * viewer.reportSource({
+     *   report: "MyReport",
+     *   parameters: { StartDate: "2024-01-01", EndDate: "2024-12-31" }
+     * });
+     * @example // Clear the report source
+     * var viewer = $("#reportViewer1").data("telerik_ReportViewer");
+     * viewer.reportSource(null);
+     */
     reportSource: (rs) => {
       if (rs || rs === null) {
         controller.setReportSource(rs);
@@ -237,10 +260,31 @@ function ReportViewer(dom, options) {
       }
       return controller.getReportSource();
     },
+    /**
+     * Clears the current reportSource from the viewer's internal state and its persisted session in the browser.
+     * Called in order to force the viewer to respect the newly set reportSource on a server postback.
+     * @function
+     * @returns {ReportViewerInstance} Returns the viewer instance for chaining.
+     * @example // Clear the report source and force the viewer to respect a new reportSource on postback
+     * var viewer = $("#reportViewer1").data("telerik_ReportViewer");
+     * viewer.clearReportSource();
+     */
     clearReportSource: () => {
       controller.setReportSource(new RCV__namespace.ReportSourceOptions());
       return viewer;
     },
+    /**
+     * Gets or sets the view mode of the viewer (e.g., Interactive or Print Preview).
+     * @function
+     * @param {ViewModes} [vm] - The view mode to set. If omitted, returns the current view mode.
+     * @returns {string} Returns the viewer instance for chaining when setting, or the current view mode string when getting.
+     * @example // Get the current view mode
+     * var viewer = $("#reportViewer1").data("telerik_ReportViewer");
+     * var mode = viewer.viewMode();
+     * @example // Set the view mode to Print Preview
+     * var viewer = $("#reportViewer1").data("telerik_ReportViewer");
+     * viewer.viewMode(telerikReportViewer.ViewModes.PRINT_PREVIEW);
+     */
     viewMode: (vm) => {
       if (vm) {
         controller.setViewMode(viewModeMap[vm]);
@@ -248,6 +292,18 @@ function ReportViewer(dom, options) {
       }
       return viewModeReverseMap[controller.getViewMode()];
     },
+    /**
+     * Gets or sets the page mode (e.g., Single Page or Continuous Scroll).
+     * @function
+     * @param {PageModes} [psm] - The page mode to set. If omitted, returns the current page mode.
+     * @returns {string} Returns the viewer instance for chaining when setting, or the current page mode string when getting.
+     * @example // Get the current page mode
+     * var viewer = $("#reportViewer1").data("telerik_ReportViewer");
+     * var pageMode = viewer.pageMode();
+     * @example // Set the page mode to Single Page
+     * var viewer = $("#reportViewer1").data("telerik_ReportViewer");
+     * viewer.pageMode(telerikReportViewer.PageModes.SINGLE_PAGE);
+     */
     pageMode: (psm) => {
       if (psm) {
         controller.setPageMode(pageModeMap[psm]);
@@ -255,6 +311,18 @@ function ReportViewer(dom, options) {
       }
       return pageModeReverseMap[controller.getPageMode()];
     },
+    /**
+     * Gets or sets the print mode for the viewer.
+     * @function
+     * @param {PrintModes} [pm] - The print mode to set. If omitted, returns the current print mode.
+     * @returns {string} Returns the viewer instance for chaining when setting, or the current print mode string when getting.
+     * @example // Get the current print mode
+     * var viewer = $("#reportViewer1").data("telerik_ReportViewer");
+     * var printMode = viewer.printMode();
+     * @example // Set the print mode to Force PDF File
+     * var viewer = $("#reportViewer1").data("telerik_ReportViewer");
+     * viewer.printMode(telerikReportViewer.PrintModes.FORCE_PDF_FILE);
+     */
     printMode: (pm) => {
       if (pm) {
         controller.setPrintMode(printModeMap[pm]);
@@ -262,6 +330,20 @@ function ReportViewer(dom, options) {
       }
       return printModeReverseMap[controller.getPrintMode()];
     },
+    /**
+     * Gets or sets the scale and scale mode for the viewer.
+     * @function
+     * @param {Object} [args] - The scale settings to apply. Should contain 'scale' (number) and 'scaleMode' (string).
+     * @param {number} [args.scale] - The zoom scale (e.g., 1.0 for 100%).
+     * @param {ScaleModes} [args.scaleMode] - The scale mode (e.g., 'FIT_PAGE', 'FIT_PAGE_WIDTH', 'SPECIFIC').
+     * @returns {Object} Returns the viewer instance for chaining when setting, or an object with current scale and scaleMode when getting.
+     * @example // Get the current scale and scale mode
+     * var viewer = $("#reportViewer1").data("telerik_ReportViewer");
+     * var scaleInfo = viewer.scale();
+     * @example // Set scale to 1.2 and scale mode to FIT_PAGE_WIDTH
+     * var viewer = $("#reportViewer1").data("telerik_ReportViewer");
+     * viewer.scale({ scale: 1.2, scaleMode: telerikReportViewer.ScaleModes.FIT_PAGE_WIDTH });
+     */
     scale: (args) => {
       if (args) {
         controller.setScale(args.scale);
@@ -273,33 +355,135 @@ function ReportViewer(dom, options) {
         scaleMode: scaleModeReverseMap[controller.getScaleMode()]
       };
     },
+    /**
+     * Gets the viewer’s current page that is displayed.
+     * @function
+     * @returns {number} The current page number (1-based).
+     * @example // Get the current page number
+     * var viewer = $("#reportViewer1").data("telerik_ReportViewer");
+     * var page = viewer.currentPage();
+     */
     currentPage: () => {
       return controller.getCurrentPageNumber();
     },
+    /**
+     * Gets the total page count of the viewer’s currently displayed report.
+     * @function
+     * @returns {number} The total page count.
+     * @example // Get the total number of pages in the current report
+     * var viewer = $("#reportViewer1").data("telerik_ReportViewer");
+     * var totalPages = viewer.pageCount();
+     */
     pageCount: () => {
       return controller.getPageCount();
     },
+    /**
+     * Shows or hides the parameters area in the viewer UI.
+     * @function
+     * @param {boolean} visible - True to show, false to hide the parameters area.
+     * @returns {void}
+     * @example // Show the parameters area
+     * var viewer = $("#reportViewer1").data("telerik_ReportViewer");
+     * viewer.parametersAreaVisible(true);
+     * @example // Hide the parameters area
+     * var viewer = $("#reportViewer1").data("telerik_ReportViewer");
+     * viewer.parametersAreaVisible(false);
+     */
     parametersAreaVisible: (visible) => {
       notificationService$1.setParametersAreaVisible({ visible });
     },
+    /**
+     * Returns an object with properties, the names of which are the report parameters’ IDs, and values - the report parameters’ values. The values of multivalue parameters include their display and value members.
+     * @function
+     * @returns {Array<Object>} An array of report parameter objects.
+     * @example // Get all report parameters and log them
+     * var viewer = $("#reportViewer1").data("telerik_ReportViewer");
+     * var parameters = viewer.getReportParameters();
+     * console.log(parameters);
+     */
     getReportParameters: () => {
       return controller.getReportParameters();
     },
+    /**
+     * Returns whether auto-run is enabled for the report (i.e., whether the report runs automatically when parameters change).
+     * @function
+     * @returns {boolean} True if auto-run is enabled, false otherwise.
+     * @example // Check if auto-run is enabled for the report
+     * var viewer = $("#reportViewer1").data("telerik_ReportViewer");
+     * var isReportAutoRun = viewer.isReportAutoRun();
+     */
     isReportAutoRun: () => {
       return controller.autoRunEnabled;
     },
+    /**
+     * Sets the authentication token. Used for service requests.
+     * @function
+     * @param {string} [token] - The authentication token to set.
+     * @returns {ReportViewerInstance} Returns the viewer instance for chaining.
+     * @example // Set the authentication token for the viewer
+     * var viewer = $("#reportViewer1").data("telerik_ReportViewer");
+     * viewer.authenticationToken("YOUR_AUTH_TOKEN");
+     */
     authenticationToken: (token) => {
       if (token) {
         controller.setAuthenticationToken(token);
       }
       return viewer;
     },
+    /**
+     * Binds event handlers to the specified event.
+     * @function
+     * @param {string} eventName - The name of the event to bind to (see Events constants).
+     * @param {function} eventHandler - The handler function to invoke when the event occurs.
+     * @returns {void}
+     * @example // Bind to the 'pageReady' event
+     * var viewer = $("#reportViewer1").data("telerik_ReportViewer");
+     * viewer.bind(telerikReportViewer.Events.PAGE_READY, function(e, args) {
+     *   console.log("Page is ready!", args);
+     * });
+     * @example // Bind to the 'error' event
+     * var viewer = $("#reportViewer1").data("telerik_ReportViewer");
+     * viewer.bind(telerikReportViewer.Events.ERROR, function(e, args) {
+     *   alert("An error occurred: " + args);
+     * });
+     */
     bind: (eventName, eventHandler) => {
       eventBinder(eventName, eventHandler, true);
     },
+    /**
+     * Unbinds an event handler from a viewer event.
+     * @function
+     * @param {string} eventName - The name of the event to unbind from.
+     * @param {function} [eventHandler] - The handler function to remove. If omitted, all handlers for the event are removed.
+     * @returns {void}
+     * @example // Unbind all handlers from the 'error' event
+     * var viewer = $("#reportViewer1").data("telerik_ReportViewer");
+     * viewer.unbind(telerikReportViewer.Events.ERROR);
+     */
     unbind: (eventName, eventHandler) => {
       eventBinder(eventName, eventHandler, false);
     },
+    /**
+     * Gets or sets the accessibility key map for keyboard navigation.
+     * Allows customization of keyboard shortcuts for accessibility features.
+     * @function
+     * @param {Object} [keyMap] - The key map object to set. If omitted, acts as a getter.
+     * @returns {Object} Returns the viewer instance for chaining when setting, the current key map when getting, or undefined if accessibility is not enabled.
+     * @example // Get the current accessibility key map
+     * var viewer = $("#reportViewer1").data("telerik_ReportViewer");
+     * var keyMap = viewer.accessibilityKeyMap();
+     *
+     * @example // Set a custom accessibility key map
+     * var reportViewer = $("#reportViewer1").data("telerik_ReportViewer");
+     * reportViewer.accessibilityKeyMap(
+     * {
+     *     CONFIRM_KEY: 32,
+     *     CONTENT_AREA_KEY: 82, //R
+     *     DOCUMENT_MAP_AREA_KEY: 77, //M
+     *     MENU_AREA_KEY: 85, //U
+     *     PARAMETERS_AREA_KEY: 80 //P
+     * });
+     */
     accessibilityKeyMap: (keyMap) => {
       if (accessibility$1) {
         if (keyMap) {
@@ -310,12 +494,27 @@ function ReportViewer(dom, options) {
       }
       return void 0;
     },
+    /**
+     * The command set for the viewer, providing programmatic access to built-in commands (e.g., navigation, export).
+     * @type {ReportViewerCommands}
+     */
     commands,
+    /**
+     * Disposes the viewer instance, cleaning up resources and event handlers.
+     * After calling this method, the viewer instance should not be used.
+     * Stops sending keep alive requests to the server, if keep client alive was enabled.
+     * @function
+     * @returns {void}
+     * @example
+     *  // Dispose the viewer instance when it is no longer needed
+     * var viewer = $("#reportViewer1").data("telerik_ReportViewer");
+     * viewer.dispose();
+     */
     dispose: () => {
       clearTooltipTimeout();
       controller.disposeSentinel();
       controller.destroy();
-      if (perspectiveManager) {
+      if (perspectiveManager && typeof perspectiveManager.dispose === "function") {
         perspectiveManager.dispose();
       }
     }
@@ -451,6 +650,9 @@ function ReportViewer(dom, options) {
   function enableTouch(dom2) {
     var allowSwipeLeft;
     var allowSwipeRight;
+    function isMobileDevice() {
+      return /Mobile|Android|webOS|iPhone|iPad|iPod|BlackBerry|Opera Mini|Windows Phone/i.test(navigator.userAgent) || /Macintosh/i.test(navigator.userAgent) && navigator.maxTouchPoints && navigator.maxTouchPoints > 0;
+    }
     touch.TouchBehavior(
       dom2,
       {
@@ -473,7 +675,9 @@ function ReportViewer(dom, options) {
           controller.setScale(scale * f);
         },
         doubletap: function() {
-          commands.toggleZoomMode.exec();
+          if (isMobileDevice()) {
+            commands.toggleZoomMode.exec();
+          }
         },
         touchstart: function() {
           var el = dom2.find(".trv-page-wrapper")[0];
@@ -602,8 +806,8 @@ function ReportViewer(dom, options) {
       settings.setScale(scale);
     }).on("clientIdChanged", (clientId) => {
       settings.setClientId(clientId);
-    }).on("currentPageChanged", (page) => {
-      settings.setPageNumber(page);
+    }).on("currentPageChanged", (args) => {
+      settings.setPageNumber(args.page);
     }).on("reportSourceChanged", (rs) => {
       settings.setReportSource(rs);
     });
@@ -676,10 +880,7 @@ function ReportViewer(dom, options) {
         notificationService$1.setDocumentMapVisible({ visible: false });
       }
     }).on("navigateToReport", (args) => {
-      controller.setReportSource({
-        report: args.Report,
-        parameters: args.Parameters
-      });
+      controller.setReportSource(args);
       controller.refreshReport(false);
     }).on("toolTipOpening", (args) => {
       showTooltip(args);

package/dist/cjs/sr.js

@@ -31,6 +31,7 @@ var sr = {
   errorCreatingReportInstance: "Error creating report instance (Report = '{0}').",
   errorCreatingReportDocument: "Error creating report document (Report = '{0}'; Format = '{1}').",
   unableToGetReportParameters: "Unable to get report parameters.",
+  errorUnauthorizedOrForbidden: "You don't have permission to access this report document.",
   errorObtainingAuthenticationToken: "Error obtaining authentication token.",
   clientExpired: "Click 'Refresh' to restore client session.",
   promisesChainStopError: "Error shown. Throwing promises chain stop error.",

package/dist/font/font-icons.css

@@ -1,5 +1,5 @@
 /*
-* TelerikReporting v19.2.25.1001 (https://www.telerik.com/products/reporting.aspx)
+* TelerikReporting v19.3.25.1111 (https://www.telerik.com/products/reporting.aspx)
 * Copyright 2025 Progress Software EAD. All rights reserved.
 *
 * Telerik Reporting commercial licenses may be obtained at
@@ -10,14 +10,14 @@
   font-family: "ReportingIcons";
   font-style: normal;
   font-weight: normal;
-  src: url("../ReportingIcons-19.2.25.1001.ttf/") format("truetype");
+  src: url("../ReportingIcons-19.3.25.1111.ttf/") format("truetype");
   /*unicode-range: U+E0ED, U+E0EE, U+E0E6, U+E132, U+E12F, U+E008, U+E00B, U+E09C, U+E096, U+E07E, U+E086, U+E06C, U+E07F, U+E080, U+E081, U+E149, U+E087;*/
 }
 @font-face {
   font-family: "WebComponentsIcons";
   font-style: normal;
   font-weight: normal;
-  src: url("../ReportingIcons-19.2.25.1001.ttf/") format("truetype");
+  src: url("../ReportingIcons-19.3.25.1111.ttf/") format("truetype");
 }
 .k-icon {
   /* use !important to prevent issues with browser extensions that change fonts */
@@ -4256,4 +4256,4 @@
 .trv-report-viewer .t-i-scroll:before {
   content: "\e022";
 }
-/* DO NOT MODIFY OR DELETE THIS LINE! UPGRADE WIZARD CHECKSUM 071e77464fbd3caaca0925ace388ba2c */
+/* DO NOT MODIFY OR DELETE THIS LINE! UPGRADE WIZARD CHECKSUM f7abb5da4db19fb4ee5ca88c31b92797 */