@sapui5/types 1.122.2 → 1.123.1

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.122.0
+// For Library Version: 1.123.0
 
 declare module "sap/rules/ui/library" {
   /**
@@ -88,9 +88,6 @@ declare module "sap/rules/ui/library" {
    * given set of inputs.
    *
    * This enum is part of the 'sap/rules/ui/library' module export and must be accessed by the property 'RuleHitPolicy'.
-   *
-   * @deprecated (since 1.120.2) - to configure the settings, use the Manage Rules Project app or the Rule
-   * Authoring APIs.
    */
   export enum RuleHitPolicy {
     /**
@@ -303,7 +300,7 @@ declare module "sap/rules/ui/DecisionTableConfiguration" {
      * The value determines whether the user can set the rendering of the decision Table to be based on cellFormat
      * or rule Format
      *
-     * Default value is `CellFormat`.
+     * Default value is `RuleFormat`.
      *
      *
      * @returns Value of property `decisionTableFormat`
@@ -400,7 +397,7 @@ declare module "sap/rules/ui/DecisionTableConfiguration" {
      *
      * When called with a value of `null` or `undefined`, the default value of the property will be restored.
      *
-     * Default value is `CellFormat`.
+     * Default value is `RuleFormat`.
      *
      *
      * @returns Reference to `this` in order to allow method chaining
@@ -510,7 +507,9 @@ declare module "sap/rules/ui/DecisionTableConfiguration" {
       iVisibleRowCount?: int
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the DecisionTableConfiguration constructor.
+   */
   export interface $DecisionTableConfigurationSettings
     extends $ElementSettings {
     /**
@@ -569,12 +568,18 @@ declare module "sap/rules/ui/DecisionTableConfiguration" {
     change?: (oEvent: DecisionTableConfiguration$ChangeEvent) => void;
   }
 
+  /**
+   * Parameters of the DecisionTableConfiguration#change event.
+   */
   export interface DecisionTableConfiguration$ChangeEventParameters {
     name?: undefined;
 
     value?: undefined;
   }
 
+  /**
+   * Event object of the DecisionTableConfiguration#change event.
+   */
   export type DecisionTableConfiguration$ChangeEvent = Event<
     DecisionTableConfiguration$ChangeEventParameters,
     DecisionTableConfiguration
@@ -843,7 +848,9 @@ declare module "sap/rules/ui/RuleBuilder" {
       sTypes?: RuleType[]
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the RuleBuilder constructor.
+   */
   export interface $RuleBuilderSettings extends $ControlSettings {
     /**
      * Available types that can be created using the `sap.rules.ui.RuleBuilder` control. If empty, all rule
@@ -1043,7 +1050,9 @@ declare module "sap/rules/ui/services/AstExpressionLanguage" {
       sBindingContextPath: string
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the AstExpressionLanguage constructor.
+   */
   export interface $AstExpressionLanguageSettings extends $ElementSettings {
     /**
      * Path to a Vocabulary object in the model data, which is used for the definition of relative context bindings
@@ -1054,8 +1063,14 @@ declare module "sap/rules/ui/services/AstExpressionLanguage" {
     dataChange?: (oEvent: Event) => void;
   }
 
+  /**
+   * Parameters of the AstExpressionLanguage#dataChange event.
+   */
   export interface AstExpressionLanguage$DataChangeEventParameters {}
 
+  /**
+   * Event object of the AstExpressionLanguage#dataChange event.
+   */
   export type AstExpressionLanguage$DataChangeEvent = Event<
     AstExpressionLanguage$DataChangeEventParameters,
     AstExpressionLanguage
@@ -1248,7 +1263,11 @@ declare module "sap/rules/ui/services/ExpressionLanguage" {
       oValueHelpCallback: any
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the ExpressionLanguage constructor.
+   *
+   * @deprecated (since 1.120.2) - use the attribute astExpressionLanguage instead.
+   */
   export interface $ExpressionLanguageSettings extends $ElementSettings {
     /**
      * The valueHelpCallback is a function that receives by reference an array of value help metadata and adds
@@ -1266,8 +1285,14 @@ declare module "sap/rules/ui/services/ExpressionLanguage" {
     dataChange?: (oEvent: Event) => void;
   }
 
+  /**
+   * Parameters of the ExpressionLanguage#dataChange event.
+   */
   export interface ExpressionLanguage$DataChangeEventParameters {}
 
+  /**
+   * Event object of the ExpressionLanguage#dataChange event.
+   */
   export type ExpressionLanguage$DataChangeEvent = Event<
     ExpressionLanguage$DataChangeEventParameters,
     ExpressionLanguage
@@ -1555,7 +1580,9 @@ declare module "sap/rules/ui/TextRuleConfiguration" {
       bEnableSettings?: boolean
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the TextRuleConfiguration constructor.
+   */
   export interface $TextRuleConfigurationSettings extends $ElementSettings {
     /**
      * The value determines whether the Settings button is displayed in a Text Rule when the control is used
@@ -1587,12 +1614,18 @@ declare module "sap/rules/ui/TextRuleConfiguration" {
     change?: (oEvent: TextRuleConfiguration$ChangeEvent) => void;
   }
 
+  /**
+   * Parameters of the TextRuleConfiguration#change event.
+   */
   export interface TextRuleConfiguration$ChangeEventParameters {
     name?: undefined;
 
     value?: undefined;
   }
 
+  /**
+   * Event object of the TextRuleConfiguration#change event.
+   */
   export type TextRuleConfiguration$ChangeEvent = Event<
     TextRuleConfiguration$ChangeEventParameters,
     TextRuleConfiguration

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.122.1
+// For Library Version: 1.123.1
 
 declare module "sap/sac/df/library" {}
 
@@ -70,7 +70,11 @@ declare module "sap/sac/df/changeHandler/MultiDimModelChangeHandler" {
      */
     skipApplyModelChangeOnce(): void;
   }
-
+  /**
+   * Describes the settings that can be provided to the MultiDimModelChangeHandler constructor.
+   *
+   * @experimental (since 1.120)
+   */
   export interface $MultiDimModelChangeHandlerSettings
     extends $ControlSettings {}
 }
@@ -93,10 +97,6 @@ declare module "sap/sac/df/FilterBar" {
   export default class FilterBar extends FilterBar1 {
     /**
      * Constructor for a new Filter Bar.
-     *
-     * 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();
 
@@ -140,18 +140,6 @@ declare module "sap/sac/df/FilterBar" {
      * @returns Value of property `metaPath`
      */
     getMetaPath(): string;
-    /**
-     * Gets current value of property {@link #getMode mode}.
-     *
-     * Mode
-     *
-     * Default value is `"VariablesOfDataProvider"`.
-     *
-     * @deprecated - please use the property `metaPath` instead
-     *
-     * @returns Value of property `mode`
-     */
-    getMode(): string;
     /**
      * Sets a new value for property {@link #getMetaPath metaPath}.
      *
@@ -168,39 +156,17 @@ declare module "sap/sac/df/FilterBar" {
        */
       sMetaPath: string
     ): this;
-    /**
-     * Sets a new value for property {@link #getMode mode}.
-     *
-     * Mode
-     *
-     * When called with a value of `null` or `undefined`, the default value of the property will be restored.
-     *
-     * Default value is `"VariablesOfDataProvider"`.
-     *
-     * @deprecated - please use the property `metaPath` instead
-     *
-     * @returns Reference to `this` in order to allow method chaining
-     */
-    setMode(
-      /**
-       * New value for property `mode`
-       */
-      sMode?: string
-    ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the FilterBar constructor.
+   *
+   * @experimental (since 1.119)
+   */
   export interface $FilterBarSettings extends $FilterBarSettings1 {
     /**
      * Defines the relative path of the property in the metamodel, based on the current contextPath.
      */
     metaPath?: string | PropertyBindingInfo;
-
-    /**
-     * Mode
-     *
-     * @deprecated - please use the property `metaPath` instead
-     */
-    mode?: string | PropertyBindingInfo;
   }
 }
 
@@ -359,7 +325,11 @@ declare module "sap/sac/df/FilterField" {
       sSearchAttributes: string[]
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the FilterField constructor.
+   *
+   * @experimental (since 1.48.0)
+   */
   export interface $FilterFieldSettings extends $FieldBaseSettings {
     /**
      * Defines the relative path of the property in the metamodel, based on the current contextPath.
@@ -1351,7 +1321,11 @@ declare module "sap/sac/df/FlexAnalysis" {
      */
     unbindDataProvider(): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the FlexAnalysis constructor.
+   *
+   * @experimental
+   */
   export interface $FlexAnalysisSettings extends $ControlSettings {
     /**
      * Sets title to be shown in the control. If not set the name of the corresponding back-end query is used
@@ -1503,6 +1477,9 @@ declare module "sap/sac/df/FlexAnalysis" {
     onCellClick?: (oEvent: FlexAnalysis$OnCellClickEvent) => void;
   }
 
+  /**
+   * Parameters of the FlexAnalysis#onCellClick event.
+   */
   export interface FlexAnalysis$OnCellClickEventParameters {
     /**
      * Cell context
@@ -1510,6 +1487,9 @@ declare module "sap/sac/df/FlexAnalysis" {
     cellContext?: object;
   }
 
+  /**
+   * Event object of the FlexAnalysis#onCellClick event.
+   */
   export type FlexAnalysis$OnCellClickEvent = Event<
     FlexAnalysis$OnCellClickEventParameters,
     FlexAnalysis
@@ -1696,7 +1676,11 @@ declare module "sap/sac/df/FlexAnalysisPanel" {
       sTitle: string
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the FlexAnalysisPanel constructor.
+   *
+   * @experimental
+   */
   export interface $FlexAnalysisPanelSettings extends $ElementSettings {
     /**
      * The description of the panel, displayed as tooltip on the side navigation item.
@@ -2550,25 +2534,36 @@ declare module "sap/sac/df/model/Dimension" {
   }
 }
 
-declare module "sap/sac/df/model/Document" {
+declare module "sap/sac/df/model/Documents" {
   import BaseObject from "sap/ui/base/Object";
 
+  import DocumentsSupportType from "sap/sac/df/types/DocumentsSupportType";
+
   import Metadata from "sap/ui/base/Metadata";
 
   /**
-   * Document Object
+   * Documents manager object
+   *
+   * **Structure of Exposed Data:**
+   * ```javascript
+   *
+   * "ActiveDocumentsDirectory": "",
+   * "DocumentsSupportType": ""
+   * "IsBasedOnCDSView": ""
+   * ```
+   *
    *
    * @since 1.119
    * @experimental (since 1.119)
    */
-  export default class Document extends BaseObject {
+  export default class Documents extends BaseObject {
     /**
      * @ui5-protected Do not call from applications (only from related classes in the framework)
      */
     protected constructor();
 
     /**
-     * Creates a new subclass of class sap.sac.df.model.Document with name `sClassName` and enriches it with
+     * Creates a new subclass of class sap.sac.df.model.Documents 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.Object.extend}.
@@ -2584,7 +2579,7 @@ declare module "sap/sac/df/model/Document" {
       /**
        * Object literal with information about the class
        */
-      oClassInfo?: sap.ClassInfo<T, Document>,
+      oClassInfo?: sap.ClassInfo<T, Documents>,
       /**
        * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
        * used by this class
@@ -2592,14 +2587,14 @@ declare module "sap/sac/df/model/Document" {
       FNMetaImpl?: Function
     ): Function;
     /**
-     * Returns a metadata object for class sap.sac.df.model.Document.
+     * Returns a metadata object for class sap.sac.df.model.Documents.
      *
      *
      * @returns Metadata object describing this class
      */
     static getMetadata(): Metadata;
     /**
-     * Creates a document in the document store
+     * Create a document in the document store
      *
      *
      * @returns a promise which resolves to true if create operation is successful, otherwise false.
@@ -2631,7 +2626,7 @@ declare module "sap/sac/df/model/Document" {
       nColumnIndex: int
     ): Promise<String>;
     /**
-     * Deletes a document in the document store
+     * Delete a document in the document store
      *
      *
      * @returns a promise which resolves to true if delete operation is successful, otherwise false.
@@ -2643,7 +2638,7 @@ declare module "sap/sac/df/model/Document" {
       sDocumentId: undefined
     ): Promise<boolean>;
     /**
-     * Deletes a document ID for a data cell in the result set
+     * Delete a document ID for a data cell in the result set
      *
      *
      * @returns a promise which resolves to true if the delete operation is successful, otherwise false.
@@ -2659,7 +2654,7 @@ declare module "sap/sac/df/model/Document" {
       nColumnIndex: int
     ): Promise<boolean>;
     /**
-     * Gets a document ID of a data cell in the result set
+     * Get a document ID of a data cell in the result set
      *
      *
      * @returns a promise which resolves with the document ID
@@ -2675,12 +2670,12 @@ declare module "sap/sac/df/model/Document" {
       nColumnIndex: int
     ): Promise<String>;
     /**
-     * Gets the type of DocumentsSupport.
+     * Get the type of documents support.
      *
      *
-     * @returns DocumentsSupport type
+     * @returns documents support type
      */
-    getDocumentsSupportType(): string;
+    getDocumentsSupportType(): DocumentsSupportType;
     /**
      * Retrieves a document from the document store
      *
@@ -2698,7 +2693,7 @@ declare module "sap/sac/df/model/Document" {
       sVersion: undefined
     ): Promise<object>;
     /**
-     * Retrieves multiple documents from the document store
+     * Retrieve multiple documents from the document store
      *
      *
      * @returns a promise which resolves with all documents and its versions.
@@ -2710,7 +2705,14 @@ declare module "sap/sac/df/model/Document" {
       aDocumentIds: undefined
     ): Promise<object>;
     /**
-     * Updates a document in the document store
+     * Is document storage supporting Read / Write access
+     *
+     *
+     * @returns if Read / Write access is supported
+     */
+    supportsReadWrite(): boolean;
+    /**
+     * Update a document in the document store
      *
      *
      * @returns a promise which resolves to true if update operation is successful, otherwise false.
@@ -2731,7 +2733,7 @@ declare module "sap/sac/df/model/Document" {
 declare module "sap/sac/df/model/Grid" {
   import BaseObject from "sap/ui/base/Object";
 
-  import Document from "sap/sac/df/model/Document";
+  import Documents from "sap/sac/df/model/Documents";
 
   import Metadata from "sap/ui/base/Metadata";
 
@@ -2749,7 +2751,7 @@ declare module "sap/sac/df/model/Grid" {
     /**
      * Documents
      */
-    Documents: Document;
+    Documents: Documents;
 
     /**
      * Creates a new subclass of class sap.sac.df.model.Grid with name `sClassName` and enriches it with the
@@ -3172,30 +3174,53 @@ declare module "sap/sac/df/model/MultiDimModel" {
       aVariableGroups: VariableGroup[]
     ): Promise<VariableGroup[]>;
   }
-
+  /**
+   * Parameters of the MultiDimModel#dataProviderAdded event.
+   */
   export interface MultiDimModel$DataProviderAddedEventParameters {}
 
+  /**
+   * Event object of the MultiDimModel#dataProviderAdded event.
+   */
   export type MultiDimModel$DataProviderAddedEvent = Event<
     MultiDimModel$DataProviderAddedEventParameters,
     MultiDimModel
   >;
 
+  /**
+   * Parameters of the MultiDimModel#dataProviderRemoved event.
+   */
   export interface MultiDimModel$DataProviderRemovedEventParameters {}
 
+  /**
+   * Event object of the MultiDimModel#dataProviderRemoved event.
+   */
   export type MultiDimModel$DataProviderRemovedEvent = Event<
     MultiDimModel$DataProviderRemovedEventParameters,
     MultiDimModel
   >;
 
+  /**
+   * Parameters of the MultiDimModel#dataProviderUpdated event.
+   */
   export interface MultiDimModel$DataProviderUpdatedEventParameters {}
 
+  /**
+   * Event object of the MultiDimModel#dataProviderUpdated event.
+   */
   export type MultiDimModel$DataProviderUpdatedEvent = Event<
     MultiDimModel$DataProviderUpdatedEventParameters,
     MultiDimModel
   >;
 
+  /**
+   * Parameters of the MultiDimModel#loaded event.
+   */
   export interface MultiDimModel$LoadedEventParameters {}
 
+  /**
+   * Event object of the MultiDimModel#loaded event.
+   */
   export type MultiDimModel$LoadedEvent = Event<
     MultiDimModel$LoadedEventParameters,
     MultiDimModel
@@ -3695,6 +3720,31 @@ declare module "sap/sac/df/types/DataSourceType" {
   export default DataSourceType;
 }
 
+declare module "sap/sac/df/types/DocumentsSupportType" {
+  /**
+   * Documents support type
+   */
+  enum DocumentsSupportType {
+    /**
+     * Documents are not supported.
+     */
+    None = "NONE",
+    /**
+     * Read-only documents support.
+     */
+    Read = "READ",
+    /**
+     * Read, create, change documents support
+     */
+    ReadCreateChange = "READ_CREATE_CHANGE",
+    /**
+     * Read, create, change, delete documents support.
+     */
+    ReadWrite = "READ_WRITE",
+  }
+  export default DocumentsSupportType;
+}
+
 declare module "sap/sac/df/types/SystemType" {
   /**
    * System Type of an InA System
@@ -3742,7 +3792,7 @@ declare namespace sap {
 
     "sap/sac/df/model/Dimension": undefined;
 
-    "sap/sac/df/model/Document": undefined;
+    "sap/sac/df/model/Documents": undefined;
 
     "sap/sac/df/model/Grid": undefined;
 
@@ -3754,6 +3804,8 @@ declare namespace sap {
 
     "sap/sac/df/types/DataSourceType": undefined;
 
+    "sap/sac/df/types/DocumentsSupportType": undefined;
+
     "sap/sac/df/types/SystemType": undefined;
   }
 }