@sapui5/ts-types 1.108.4 → 1.108.5

package/types/sap.ndc.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.108.2
+// For Library Version: 1.108.3
 
 declare namespace sap {
   /**
@@ -9,7 +9,7 @@ declare namespace sap {
       extends sap.ui.core.$ControlSettings {
       /**
        * If set to true, the button remains visible if the scanner is not available and triggers a dialog to enter
-       * bar code.
+       * barcode.
        */
       provideFallback?:
         | boolean
@@ -17,7 +17,7 @@ declare namespace sap {
         | `{${string}}`;
 
       /**
-       * The invisible bar code scanner button is not rendered regardless of the availability of the native scan
+       * The invisible barcode scanner button is not rendered regardless of the availability of the native scan
        * feature.
        */
       visible?:
@@ -34,7 +34,7 @@ declare namespace sap {
         | `{${string}}`;
 
       /**
-       * Defines the bar code input dialog title. If unset, a predefined title will be used.
+       * Defines the barcode input dialog title. If unset, a predefined title will be used.
        */
       dialogTitle?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
 
@@ -90,7 +90,7 @@ declare namespace sap {
      * @SINCE 1.28.0
      *
      * Please refer to SAP
-     * Note 2402585 for information on barcode scanner support in native iOS and Android browsers.
+     * Note 2402585 for information on Barcode Scanner support in native iOS and Android browsers.
      *
      * Here is an example of how to trigger the scan function of BarcodeScanner:
      * ```javascript
@@ -116,35 +116,71 @@ declare namespace sap {
      */
     interface BarcodeScanner {
       /**
-       * Closes the bar code input dialog. It can be used to close the dialog before the user presses the OK or
+       * Closes the barcode input dialog. It can be used to close the dialog before the user presses the OK or
        * the Cancel button (e.g. in the fnLiveUpdate callback function of the {@link sap.ndc.BarcodeScanner.scan}
        * method.)
        */
       closeScanDialog(): void;
       /**
-       * Returns the API info that will be used to scan.
+       * Returns the scanner API info that will be used to scan the barcode.
        *
-       * @returns The Barcode Scanner API info. (e.g. ZebraEnterpriseBrowser, Cordova, ZXing or unknown)
+       * @returns The Barcode Scanner API info. (e.g. ZebraEnterpriseBrowser, Cordova, ZXingCPP, ZXing or unknown)
        */
       getScanAPIInfo(): string;
       /**
-       * Returns the status model of the BarcodeScanner. It is a JSON model which contains a single boolean property
-       * '`available`' indicating whether or not the bar code scanner feature is available. It can be used to
-       * bind to the `visible` property of UI controls which have to be hidden in case the feature is unavailable.
+       * Returns the status model of the Barcode Scanner. It is a JSON model which contains below properties:
        *
-       * @returns A JSON model containing the 'available' property
+       * ```javascript
+       *
+       * {
+       * 		scannerAPI: "ZXingCPP",
+       * 		available: true,
+       * 		deviceId: undefined,
+       * 		devices: [],
+       * 		apis: [
+       * 			{
+       * 				key: "ZebraEnterpriseBrowser",
+       * 				status: "UnAvailable"
+       * 			},
+       * 			{
+       * 				key: "Cordova",
+       * 				status: "UnAvailable"
+       * 			},
+       * 			{
+       * 				key: "ZXingCPP",
+       * 				status: "Available"
+       * 			},
+       * 			{
+       * 				key: "ZXing",
+       * 				status: "Initial"
+       * 			}
+       * 		]
+       * 	}
+       * ```
+       *  '`scannerAPI`' shows the current scanner API used to scan the Barcode. '`available`' indicating whether
+       * or not the Barcode Scanner feature is available. It can be used to bind to the `visible` property of
+       * UI controls which have to be hidden in case the feature is unavailable. '`deviceId`' lists the current
+       * used camera id of current device. Not working for iOS devices since do not support to get all the cameras.
+       * '`devices`' lists all the cameras of current device. Not working for iOS devices since do not support
+       * to get all the cameras. '`apis`' lists scanner APIs with status value. Status value can be: "Initial",
+       * "Loading", "Available" or "UnAvailable".
+       *
+       * IMPORTANT: This model just shows current status of Barcode Scanner. Any change to it will not impact
+       * Barcode Scanner.
+       *
+       * @returns The Barcode Scanner Status Model
        */
       getStatusModel(): sap.ui.model.json.JSONModel;
       /**
-       * Starts the bar code scanning process either showing the live input from the camera or displaying a dialog
-       * to enter the value directly if the bar code scanning feature is not available.
+       * Starts the barcode scanning process either showing the live input from the camera or displaying a dialog
+       * to enter the value directly if the barcode scanning feature is unavailable.
        *
-       * The bar code scanning is done asynchronously. When it is triggered, this function returns without waiting
+       * The barcode scanning is done asynchronously. When it is triggered, this function returns without waiting
        * for the scanning process to finish. The applications have to provide callback functions to react to the
        * events of a successful scanning, an error during scanning, and the live input on the dialog.
        *
        * `fnSuccess` is passed an object with text, format and cancelled properties. Text is the text representation
-       * of the bar code data, format is the type of the bar code detected, and cancelled is whether or not the
+       * of the barcode data, format is the type of the barcode detected, and cancelled is whether or not the
        * user cancelled the scan. `fnError` is given the error, `fnLiveUpdate` is passed the new value entered
        * in the dialog's input field. An example:
        *
@@ -154,7 +190,7 @@ declare namespace sap {
        * sap.ui.require(["sap/ndc/BarcodeScanner"], function(BarcodeScanner) {
        * 	BarcodeScanner.scan(
        * 		function (mResult) {
-       * 			alert("We got a bar code\n" +
+       * 			alert("We got a barcode\n" +
        * 			 	"Result: " + mResult.text + "\n" +
        * 			 	"Format: " + mResult.format + "\n" +
        * 			 	"Cancelled: " + mResult.cancelled);
@@ -165,7 +201,7 @@ declare namespace sap {
        * 		function (mParams) {
        * 			alert("Value entered: " + mParams.newValue);
        * 		},
-       * 		"Enter Product Bar Code",
+       * 		"Enter Product Barcode",
        * 		true,
        * 		30,
        * 		1,
@@ -188,7 +224,7 @@ declare namespace sap {
          */
         fnLiveUpdate?: Function,
         /**
-         * Defines the bar code input dialog title. If unset, a predefined title will be used.
+         * Defines the barcode input dialog title. If unset, a predefined title will be used.
          */
         dialogTitle?: string,
         /**
@@ -208,6 +244,19 @@ declare namespace sap {
          */
         keepCameraScan?: boolean
       ): void;
+      /**
+       * Set the configs of the control Barcode Scanner.
+       */
+      setConfig(
+        /**
+         * The options are the configs that will be used to scan. It is a object which contains below key and value:
+         * { "enableGS1Header": true, //If set to true, add the symbology identifier (GS1 specification 5.4.3.7.
+         * and 5.4.6.4.) as prefix into the result text "deviceId": "string" // The specific camera id to scan the
+         * Barcode. If set to "", Barcode Scanner will use default camera. This option is not working for iOS devices
+         * since do not support to get all the cameras. }
+         */
+        options?: object
+      ): void;
       /**
        * Set the callback function for the physical scan button.
        */
@@ -217,13 +266,30 @@ declare namespace sap {
          */
         fnPhysicalScan?: Function
       ): void;
+      /**
+       * Set the scanner API info that will be used to scan the barcode.
+       *
+       * IMPORTANT: The status of the scanner API must be **"Available"**(for ZXingCPP and ZXing, status is **NOT
+       * "UnAvailable"**), or will return False. Scanner APIs with status value can be got by using {@link #getStatusModel}.
+       * By default, Barcode Scanner will select the scanner API(Available) with priority: ZebraEnterpriseBrowser
+       * > Cordova > ZXingCPP > ZXing.
+       *
+       * @returns Return True if set success.
+       */
+      setScanAPIInfo(
+        /**
+         * Defines the scanner API to scan the barcode. Scanner API can be "ZebraEnterpriseBrowser", "Cordova",
+         * "ZXingCPP" or "ZXing".
+         */
+        scannerAPI?: string
+      ): boolean;
     }
     const BarcodeScanner: BarcodeScanner;
 
     /**
-     * A button control (displaying a bar code icon) to start the bar code scanning process. If the native scanning
+     * A button control (displaying a barcode icon) to start the barcode scanning process. If the native scanning
      * feature is not available or camera capability is not granted, the button is either hidden or it provides
-     * a fallback by opening a dialog with an input field where the bar code can be entered manually.
+     * a fallback by opening a dialog with an input field where the barcode can be entered manually.
      */
     class BarcodeScannerButton extends sap.ui.core.Control {
       /**
@@ -513,11 +579,11 @@ declare namespace sap {
          */
         mParameters?: {
           /**
-           * The the text representation of the bar code data.
+           * The the text representation of the barcode data.
            */
           text?: string;
           /**
-           * The type of the bar code detected.
+           * The type of the barcode detected.
            */
           format?: string;
           /**
@@ -529,7 +595,7 @@ declare namespace sap {
       /**
        * Gets current value of property {@link #getDialogTitle dialogTitle}.
        *
-       * Defines the bar code input dialog title. If unset, a predefined title will be used.
+       * Defines the barcode input dialog title. If unset, a predefined title will be used.
        *
        * @returns Value of property `dialogTitle`
        */
@@ -566,7 +632,7 @@ declare namespace sap {
        * Gets current value of property {@link #getProvideFallback provideFallback}.
        *
        * If set to true, the button remains visible if the scanner is not available and triggers a dialog to enter
-       * bar code.
+       * barcode.
        *
        * Default value is `true`.
        *
@@ -576,7 +642,7 @@ declare namespace sap {
       /**
        * Gets current value of property {@link #getVisible visible}.
        *
-       * The invisible bar code scanner button is not rendered regardless of the availability of the native scan
+       * The invisible barcode scanner button is not rendered regardless of the availability of the native scan
        * feature.
        *
        * Default value is `true`.
@@ -603,7 +669,7 @@ declare namespace sap {
       /**
        * Sets a new value for property {@link #getDialogTitle dialogTitle}.
        *
-       * Defines the bar code input dialog title. If unset, a predefined title will be used.
+       * Defines the barcode input dialog title. If unset, a predefined title will be used.
        *
        * When called with a value of `null` or `undefined`, the default value of the property will be restored.
        *
@@ -668,7 +734,7 @@ declare namespace sap {
        * Sets a new value for property {@link #getProvideFallback provideFallback}.
        *
        * If set to true, the button remains visible if the scanner is not available and triggers a dialog to enter
-       * bar code.
+       * barcode.
        *
        * When called with a value of `null` or `undefined`, the default value of the property will be restored.
        *
@@ -685,7 +751,7 @@ declare namespace sap {
       /**
        * Sets a new value for property {@link #getVisible visible}.
        *
-       * The invisible bar code scanner button is not rendered regardless of the availability of the native scan
+       * The invisible barcode scanner button is not rendered regardless of the availability of the native scan
        * feature.
        *
        * When called with a value of `null` or `undefined`, the default value of the property will be restored.

package/types/sap.ovp.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.108.1
+// For Library Version: 1.108.2
 
 declare namespace sap {
   /**
@@ -6,6 +6,19 @@ declare namespace sap {
    */
   namespace ovp {
     namespace app {
+      interface $ComponentSettings extends sap.fe.core.$AppComponentSettings {
+        cardContainerFragment?:
+          | string
+          | sap.ui.base.ManagedObject.PropertyBindingInfo;
+
+        dashboardLayoutUtil?: /* was: sap.ovp.ui.DashboardLayoutUtil */
+          | any
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
+
+        designtimePath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
+      }
+
       /**
        * This class contains all extension functions that can be implemented by the application developers in
        * their extension code. Application developers must not override any methods that are not mentioned in
@@ -43,10 +56,121 @@ declare namespace sap {
         getMetadata(): sap.ui.base.Metadata;
       }
       const TemplateBaseExtension: TemplateBaseExtension;
+
+      /**
+       * Overview Page Application Component
+       */
+      class Component extends sap.fe.core.AppComponent {
+        /**
+         * Main class used for Overview Page Application Component
+         *
+         * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
+         * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
+         * of the syntax of the settings object.
+         */
+        constructor();
+
+        /**
+         * Creates a new subclass of class sap.ovp.app.Component 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.fe.core.AppComponent.extend}.
+         *
+         * @returns Created class / constructor function
+         */
+        static extend<T extends Record<string, unknown>>(
+          /**
+           * Name of the class being created
+           */
+          sClassName: string,
+          /**
+           * Object literal with information about the class
+           */
+          oClassInfo?: sap.ClassInfo<T, sap.ovp.app.Component>,
+          /**
+           * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
+           * used by this class
+           */
+          FNMetaImpl?: Function
+        ): Function;
+        /**
+         * Returns a metadata object for class sap.ovp.app.Component.
+         *
+         * @returns Metadata object describing this class
+         */
+        static getMetadata(): sap.ui.core.ComponentMetadata;
+        /**
+         * Gets current value of property {@link #getCardContainerFragment cardContainerFragment}.
+         *
+         * Default value is `"sap.ovp.app.CardContainer"`.
+         *
+         * @returns Value of property `cardContainerFragment`
+         */
+        getCardContainerFragment(): string;
+        /**
+         * Gets current value of property {@link #getDashboardLayoutUtil dashboardLayoutUtil}.
+         *
+         * @returns Value of property `dashboardLayoutUtil`
+         */
+        getDashboardLayoutUtil(): /* was: sap.ovp.ui.DashboardLayoutUtil */ any;
+        /**
+         * Gets current value of property {@link #getDesigntimePath designtimePath}.
+         *
+         * Default value is `"sap/ovp/ui/OVPWrapper.designtime"`.
+         *
+         * @returns Value of property `designtimePath`
+         */
+        getDesigntimePath(): string;
+        /**
+         * Sets a new value for property {@link #getCardContainerFragment cardContainerFragment}.
+         *
+         * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+         *
+         * Default value is `"sap.ovp.app.CardContainer"`.
+         *
+         * @returns Reference to `this` in order to allow method chaining
+         */
+        setCardContainerFragment(
+          /**
+           * New value for property `cardContainerFragment`
+           */
+          sCardContainerFragment?: string
+        ): this;
+        /**
+         * Sets a new value for property {@link #getDashboardLayoutUtil dashboardLayoutUtil}.
+         *
+         * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+         *
+         * @returns Reference to `this` in order to allow method chaining
+         */
+        setDashboardLayoutUtil(
+          /**
+           * New value for property `dashboardLayoutUtil`
+           */
+          sDashboardLayoutUtil: /* was: sap.ovp.ui.DashboardLayoutUtil */ any
+        ): this;
+        /**
+         * Sets a new value for property {@link #getDesigntimePath designtimePath}.
+         *
+         * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+         *
+         * Default value is `"sap/ovp/ui/OVPWrapper.designtime"`.
+         *
+         * @returns Reference to `this` in order to allow method chaining
+         */
+        setDesigntimePath(
+          /**
+           * New value for property `designtimePath`
+           */
+          sDesigntimePath?: string
+        ): this;
+      }
     }
   }
 
   interface IUI5DefineDependencyNames {
+    "sap/ovp/app/Component": undefined;
+
     "sap/ovp/app/TemplateBaseExtension": undefined;
 
     "sap/ovp/library": undefined;

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.108.1
+// For Library Version: 1.108.2
 
 declare namespace sap {
   namespace rules {

package/types/sap.sac.df.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.108.0
+// For Library Version: 1.108.2
 
 declare namespace sap {
   namespace sac {

package/types/sap.sac.grid.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.108.0
+// For Library Version: 1.108.2
 
 declare namespace sap {
   namespace sac {

package/types/sap.suite.ui.commons.d.ts

@@ -1,4 +1,33 @@
-// For Library Version: 1.108.1
+// For Library Version: 1.108.2
+
+declare module "sap/suite/ui/commons/collaboration/CollaborationHelper" {
+  /**
+   * @SINCE 1.108
+   *
+   * CollaborationHelper for collaboration-related functionalities
+   */
+  interface CollaborationHelper {
+    /**
+     * Determines whether the app is running in the Microsoft Teams application. If the URL parameter "sap-collaboration-teams"
+     * is set to true and if the appState is set to lean, the method ensures that the application runs in the
+     * Microsoft Teams environment
+     *
+     * @returns Return the resolved promise with the data if the conditions are met with 'true', else 'false'
+     */
+    isTeamsModeActive(): Promise<any>;
+    /**
+     * Method that checks whether the application is running in the Microsoft Teams environment. If yes, the
+     * method disables the Avatar icon on the shell. This is done synchronously. The Method returns a promise.
+     * The promise is resolved immediately if the URL is not compact. In case of a compact hash, the method
+     * retrieves the original or complete hash and replaces it in the window. The method then resolves the promise.
+     *
+     * @returns Return the resolved promise when the redirection of the URL is done.
+     */
+    processAndExpandHash(): Promise<any>;
+  }
+  const CollaborationHelper: CollaborationHelper;
+  export default CollaborationHelper;
+}
 
 declare namespace sap {
   namespace suite {
@@ -7,6 +36,25 @@ declare namespace sap {
        * SAP UI library: sap.suite.ui.commons
        */
       namespace commons {
+        namespace collaboration {
+          /**
+           * @SINCE 1.108
+           *
+           * Service container to get the collaboration type.
+           */
+          interface ServiceContainer {
+            /**
+             * Method that returns the collaboration service object as 'active' on the system. Microsoft Teams is supported
+             * as a collaboration option and must be enabled using the communication service SAP_COM_0860. The type
+             * definition and class are only available internally and are not intended for external consumers.
+             *
+             * @returns Returns the promise that is resolved to the instance of the collaboration service.
+             */
+            getServiceAsync(): Promise<any>;
+          }
+          const ServiceContainer: ServiceContainer;
+        }
+
         namespace imageeditor {
           interface $CustomSizeItemSettings
             extends sap.ui.core.$ElementSettings {
@@ -45807,6 +45855,8 @@ declare namespace sap {
 
     "sap/suite/ui/commons/collaboration/CollaborationHelper": undefined;
 
+    "sap/suite/ui/commons/collaboration/ServiceContainer": undefined;
+
     "sap/suite/ui/commons/collaboration/TeamsHelperService": undefined;
 
     "sap/suite/ui/commons/ColumnData": undefined;