@sapui5/ts-types 1.100.2 → 1.102.0

package/types/sap.ui.dt.d.ts

@@ -1,3 +1,3 @@
-// For Library Version: 1.100.0
+// For Library Version: 1.102.0
 
 declare namespace sap {}

package/types/sap.ui.export.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.100.0
+// For Library Version: 1.102.0
 
 declare namespace sap {
   namespace ui {
@@ -11,13 +11,46 @@ declare namespace sap {
        * @SINCE 1.96
        */
       class ExportBase extends sap.ui.base.EventProvider {
-        constructor();
+        /**
+         * Base class for specific SAPUI5 export implementations. This class contains abstract functions that need
+         * to be implemented.
+         */
+        constructor(
+          /**
+           * Export settings
+           */
+          mSettings: {
+            /**
+             * Data and formatting related export settings
+             */
+            workbook: object;
+            /**
+             * Source of export data. A data source properties map or `sap.ui.model.ListBinding` can be provided. An
+             * instance of `sap.ui.model.ListBinding` has to implement a `#getDownloadUrl` function.
+             */
+            dataSource: object | sap.ui.model.ListBinding;
+            /**
+             * The maximal number of records to export
+             */
+            count?: int;
+            /**
+             * Optional file name for the exported file
+             */
+            fileName?: string;
+            /**
+             * `FileType` that is used to identify the file-ending and MIME-type of the file
+             */
+            fileType?: sap.ui.export.FileType;
+          }
+        );
 
         /**
          * Creates a new subclass of class sap.ui.export.ExportBase with name `sClassName` and enriches it with
          * the information contained in `oClassInfo`.
          *
          * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.EventProvider.extend}.
+         *
+         * @returns Created class / constructor function
          */
         static extend<T extends Record<string, unknown>>(
           /**
@@ -36,6 +69,8 @@ declare namespace sap {
         ): Function;
         /**
          * Returns a metadata object for class sap.ui.export.ExportBase.
+         *
+         * @returns Metadata object describing this class
          */
         static getMetadata(): sap.ui.base.Metadata;
         /**
@@ -46,6 +81,8 @@ declare namespace sap {
          *  When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
          * otherwise it will be bound to this `sap.ui.export.ExportBase` itself.
          *  This event is fired just before the export process is started.
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         attachBeforeExport(
           /**
@@ -70,6 +107,8 @@ declare namespace sap {
          *  When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
          * otherwise it will be bound to this `sap.ui.export.ExportBase` itself.
          *  This event is fired just before the export process is started.
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         attachBeforeExport(
           /**
@@ -83,6 +122,8 @@ declare namespace sap {
         ): this;
         /**
          * Triggers the export process of the specific format.
+         *
+         * @returns Promise that gets resolved once the data has been exported
          */
         build(): Promise<any>;
         /**
@@ -95,6 +136,8 @@ declare namespace sap {
          * Detaches event handler `fnFunction` from the {@link sap.ui.export.ExportBase#event:beforeExport} event
          * of this `sap.ui.export.ExportBase`.
          *  The passed function and listener object must match the ones used for event registration.
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         detachBeforeExport(
           /**
@@ -109,16 +152,18 @@ declare namespace sap {
         /**
          * Sets the data source configuration that will be used for exporting the data. If the passed parameter
          * is null, the call will be ignored.
+         *
+         * @returns - Valid dataSource object or null in case the dataSource configuration is not supported
          */
         processDataSource(
           /**
            * Possible types are a data source configuration, a `sap.ui.model.ListBinding` or `sap.ui.model.TreeBinding`
            */
           oDataSource:
-            | Object
+            | object
             | sap.ui.model.ListBinding
             | sap.ui.model.TreeBinding
-        ): Object | null;
+        ): object | null;
       }
       /**
        * @SINCE 1.50
@@ -180,7 +225,7 @@ declare namespace sap {
          * 	 - `workbook.context` - Context object that will be applied to the generated file. It may contain the
          * 			following fields:
          * 	 - `application` (string) - The application that creates the XLSX document (default: "SAP UI5")
-         * 	 - `version` (string) - Application version that creates the XLSX document (default: "1.100.0")
+         * 	 - `version` (string) - Application version that creates the XLSX document (default: "1.102.0")
          * 	 - `title` (string) - Title of the XLSX document (NOT the filename)
          * 	 - `modifiedBy` (string) - User context for the XLSX document
          * 	 - `sheetName` (string) - The label of the data sheet
@@ -266,7 +311,7 @@ declare namespace sap {
          *       columns: aColumns,
          *       context: {
          *         application: 'Debug Test Application',
-         *         version: '1.100.0',
+         *         version: '1.102.0',
          *         title: 'Some random title',
          *         modifiedBy: 'John Doe',
          *         metaSheetName: 'Custom metadata',
@@ -432,6 +477,8 @@ declare namespace sap {
          *  When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
          * otherwise it will be bound to this `sap.ui.export.Spreadsheet` itself.
          *  This event is fired just before the generated file is saved to the file system.
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         attachBeforeSave(
           /**
@@ -456,6 +503,8 @@ declare namespace sap {
          *  When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
          * otherwise it will be bound to this `sap.ui.export.Spreadsheet` itself.
          *  This event is fired just before the generated file is saved to the file system.
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         attachBeforeSave(
           /**
@@ -471,6 +520,8 @@ declare namespace sap {
          * @SINCE 1.52
          *
          * Cancels a running export process. This method does nothing if no export is running.
+         *
+         * @returns - Reference to `this` in order to allow method chaining
          */
         cancel(): this;
         /**
@@ -479,6 +530,8 @@ declare namespace sap {
          * Detaches event handler `fnFunction` from the {@link sap.ui.export.Spreadsheet beforeSave} event of this
          * `sap.ui.export.Spreadsheet`.
          *  The passed function and listener object must match the ones used for event registration.
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         detachBeforeSave(
           /**
@@ -561,6 +614,8 @@ declare namespace sap {
   interface IUI5DefineDependencyNames {
     "sap/ui/export/ExportBase": undefined;
 
+    "sap/ui/export/ExportHandler": undefined;
+
     "sap/ui/export/ExportUtils": undefined;
 
     "sap/ui/export/library": undefined;

package/types/sap.ui.fl.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.100.0
+// For Library Version: 1.102.0
 
 declare namespace sap {
   interface IUI5DefineDependencyNames {