@sapui5/types 1.116.0 → 1.117.1

package/types/sap.insights.d.ts

@@ -1,6 +1,10 @@
-// For Library Version: 1.116.0
+// For Library Version: 1.117.0
+
+declare module "sap/insights/library" {}
 
 declare module "sap/insights/CardHelper" {
+  import CardsChannel from "sap/insights/CardsChannel";
+
   /**
    * @since 1.102
    * @experimental (since 1.102)
@@ -10,14 +14,256 @@ declare module "sap/insights/CardHelper" {
   interface CardHelper {}
   const CardHelper: CardHelper;
   export default CardHelper;
+
+  /**
+   * @experimental
+   *
+   * Public (experimental) interface of the sap.insights.UIService
+   */
+  export interface UIService {
+    __implements__sap_insights_UIService: boolean;
+
+    /**
+     * @experimental
+     *
+     * Get a promise for the singleton instance of the cards channel.
+     */
+    getCardsChannel(): Promise<CardsChannel>;
+    /**
+     * @experimental
+     *
+     * Show preview for a given card
+     */
+    showCardPreview(
+      card: object,
+
+      bTransform?: boolean,
+
+      calledInternally?: boolean
+    ): Promise<void>;
+  }
 }
 
-declare module "sap/insights/library" {}
+declare module "sap/insights/CardsChannel" {
+  import BaseObject from "sap/ui/base/Object";
+
+  import Metadata from "sap/ui/base/Metadata";
+
+  export default class CardsChannel extends BaseObject {
+    /**
+     * Provides a communication between card providers and consumers in FLP and included iframes.
+     */
+    constructor();
+
+    /**
+     * Creates a new subclass of class sap.insights.CardsChannel 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}.
+     *
+     * @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, CardsChannel>,
+      /**
+       * 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.insights.CardsChannel.
+     *
+     * @returns Metadata object describing this class
+     */
+    static getMetadata(): Metadata;
+    /**
+     * @experimental
+     *
+     * Initialize the CardsChannel either with the FLP message broker or an internal implementation for iframes.
+     */
+    init(): Promise<void>;
+    /**
+     * @experimental
+     *
+     * Checks if the broker is enabled.
+     *
+     * @returns true if the broker is enabled
+     */
+    isEnabled(): boolean;
+    /**
+     * @experimental
+     *
+     * Send a list of all available cards to a given consumer or broadcast it to all consumers.
+     */
+    publishAvailableCards(
+      providerId: string,
+
+      cardInfos: object[],
+
+      consumerId: string
+    ): Promise<void>;
+    /**
+     * @experimental
+     *
+     * Send a card to a given consumer or broadcast it to all consumers.
+     */
+    publishCard(
+      providerId: string,
+
+      card: object,
+
+      consumerId?: string
+    ): Promise<void>;
+    /**
+     * @experimental
+     *
+     * Register a card consumer with a unique id. The consumer will be notified through its callback when corresponding
+     * messages are received.
+     */
+    registerConsumer(
+      /**
+       * Unique id of the consumer
+       */
+      id: string,
+      /**
+       * Implementation of the consumer
+       */
+      consumer: ICardConsumer
+    ): Promise<void>;
+    /**
+     * @experimental
+     *
+     * Register a card provider with a unique id. The provider will be notified if new consumers get registered.
+     */
+    registerProvider(
+      /**
+       * Unique id of the provider
+       */
+      id: string,
+      /**
+       * Object implementing the ICardProvider interface
+       */
+      provider: ICardProvider
+    ): Promise<void>;
+    /**
+     * @experimental
+     *
+     * Request a card from a given provider.
+     */
+    requestCard(
+      consumerId: string,
+
+      cardId: string,
+
+      providerId: string
+    ): Promise<void>;
+    /**
+     * @experimental
+     *
+     * Unregister a previously registered consumer or provider.
+     */
+    unregister(id: string): Promise<void>;
+  }
+  /**
+   * @experimental
+   *
+   * Interface required for classes that would like to consume cards using the `sap.insights.CardsChannel`.
+   */
+  export interface ICardConsumer {
+    __implements__sap_insights_ICardConsumer: boolean;
+
+    /**
+     * @experimental
+     *
+     * Callback when a card is created for this consumer.
+     */
+    onCardProvided(
+      /**
+       * Unique id of the ICardsProvider that offers cards
+       */
+      providerId: string,
+
+      card: object
+    ): void;
+    /**
+     * @experimental
+     *
+     * Callback when cards are available.
+     */
+    onCardsAvailable(
+      /**
+       * Unique id of the ICardsProvider that offers cards
+       */
+      providerId: string,
+      /**
+       * Array of simple objects with card information
+       */
+      cardInfos: object[]
+    ): void;
+  }
+
+  /**
+   * @experimental
+   *
+   * Interface required for classes that would like to provide cards using the `sap.insights.CardsChannel`.
+   */
+  export interface ICardProvider {
+    __implements__sap_insights_ICardProvider: boolean;
+
+    /**
+     * @experimental
+     *
+     * Callback when a consumer requests a specific card.
+     */
+    onCardRequested(
+      /**
+       * Unique id of the ICardsConsumer that offers cards
+       */
+      consumerId: string,
+      /**
+       * Unique id of a card
+       */
+      cardId: string
+    ): void;
+    /**
+     * @experimental
+     *
+     * Callback when a consumer is connected.
+     */
+    onConsumerConnected(
+      /**
+       * Unique id of the ICardsConsumer that offers cards
+       */
+      consumerId: string
+    ): void;
+    /**
+     * @experimental
+     *
+     * Callback when a consumer is disconnected.
+     */
+    onConsumerDisconnected(
+      /**
+       * Unique id of the ICardsConsumer that offers cards
+       */
+      consumerId: string
+    ): void;
+  }
+}
 
 declare namespace sap {
   interface IUI5DefineDependencyNames {
     "sap/insights/CardHelper": undefined;
 
+    "sap/insights/CardsChannel": undefined;
+
     "sap/insights/library": undefined;
   }
 }

package/types/sap.landvisz.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.116.0
+// For Library Version: 1.117.0
 
 declare module "sap/landvisz/library" {
   /**
@@ -1371,7 +1371,10 @@ declare module "sap/landvisz/internal/ActionBar" {
 
   export interface ActionBar$SelectEventParameters {}
 
-  export type ActionBar$SelectEvent = Event<ActionBar$SelectEventParameters>;
+  export type ActionBar$SelectEvent = Event<
+    ActionBar$SelectEventParameters,
+    ActionBar
+  >;
 }
 
 declare module "sap/landvisz/internal/DataContainer" {
@@ -1742,7 +1745,10 @@ declare module "sap/landvisz/internal/DataContainer" {
 
   export interface DataContainer$SelectEventParameters {}
 
-  export type DataContainer$SelectEvent = Event<DataContainer$SelectEventParameters>;
+  export type DataContainer$SelectEvent = Event<
+    DataContainer$SelectEventParameters,
+    DataContainer
+  >;
 }
 
 declare module "sap/landvisz/internal/DeploymentType" {
@@ -2096,7 +2102,10 @@ declare module "sap/landvisz/internal/EntityAction" {
 
   export interface EntityAction$PressEventParameters {}
 
-  export type EntityAction$PressEvent = Event<EntityAction$PressEventParameters>;
+  export type EntityAction$PressEvent = Event<
+    EntityAction$PressEventParameters,
+    EntityAction
+  >;
 }
 
 declare module "sap/landvisz/internal/EntityCustomAction" {
@@ -2325,7 +2334,10 @@ declare module "sap/landvisz/internal/EntityCustomAction" {
 
   export interface EntityCustomAction$SelectEventParameters {}
 
-  export type EntityCustomAction$SelectEvent = Event<EntityCustomAction$SelectEventParameters>;
+  export type EntityCustomAction$SelectEvent = Event<
+    EntityCustomAction$SelectEventParameters,
+    EntityCustomAction
+  >;
 }
 
 declare module "sap/landvisz/internal/HeaderList" {
@@ -2608,7 +2620,10 @@ declare module "sap/landvisz/internal/HeaderList" {
 
   export interface HeaderList$PressEventParameters {}
 
-  export type HeaderList$PressEvent = Event<HeaderList$PressEventParameters>;
+  export type HeaderList$PressEvent = Event<
+    HeaderList$PressEventParameters,
+    HeaderList
+  >;
 }
 
 declare module "sap/landvisz/internal/IdentificationBar" {
@@ -3040,7 +3055,10 @@ declare module "sap/landvisz/internal/IdentificationBar" {
 
   export interface IdentificationBar$SelectEventParameters {}
 
-  export type IdentificationBar$SelectEvent = Event<IdentificationBar$SelectEventParameters>;
+  export type IdentificationBar$SelectEvent = Event<
+    IdentificationBar$SelectEventParameters,
+    IdentificationBar
+  >;
 }
 
 declare module "sap/landvisz/internal/LinearRowField" {
@@ -4264,7 +4282,10 @@ declare module "sap/landvisz/internal/SingleDataContainer" {
 
   export interface SingleDataContainer$ClosedEventParameters {}
 
-  export type SingleDataContainer$ClosedEvent = Event<SingleDataContainer$ClosedEventParameters>;
+  export type SingleDataContainer$ClosedEvent = Event<
+    SingleDataContainer$ClosedEventParameters,
+    SingleDataContainer
+  >;
 }
 
 declare module "sap/landvisz/internal/TreeField" {
@@ -5662,15 +5683,24 @@ declare module "sap/landvisz/LandscapeEntity" {
 
   export interface LandscapeEntity$MouseOverIdenIconEventParameters {}
 
-  export type LandscapeEntity$MouseOverIdenIconEvent = Event<LandscapeEntity$MouseOverIdenIconEventParameters>;
+  export type LandscapeEntity$MouseOverIdenIconEvent = Event<
+    LandscapeEntity$MouseOverIdenIconEventParameters,
+    LandscapeEntity
+  >;
 
   export interface LandscapeEntity$StatusSelectEventParameters {}
 
-  export type LandscapeEntity$StatusSelectEvent = Event<LandscapeEntity$StatusSelectEventParameters>;
+  export type LandscapeEntity$StatusSelectEvent = Event<
+    LandscapeEntity$StatusSelectEventParameters,
+    LandscapeEntity
+  >;
 
   export interface LandscapeEntity$TrackInfoPressEventParameters {}
 
-  export type LandscapeEntity$TrackInfoPressEvent = Event<LandscapeEntity$TrackInfoPressEventParameters>;
+  export type LandscapeEntity$TrackInfoPressEvent = Event<
+    LandscapeEntity$TrackInfoPressEventParameters,
+    LandscapeEntity
+  >;
 }
 
 declare module "sap/landvisz/LandscapeViewer" {
@@ -7116,11 +7146,17 @@ declare module "sap/landvisz/LandscapeViewer" {
 
   export interface LandscapeViewer$CloseEventParameters {}
 
-  export type LandscapeViewer$CloseEvent = Event<LandscapeViewer$CloseEventParameters>;
+  export type LandscapeViewer$CloseEvent = Event<
+    LandscapeViewer$CloseEventParameters,
+    LandscapeViewer
+  >;
 
   export interface LandscapeViewer$LoadSolutionViewEventParameters {}
 
-  export type LandscapeViewer$LoadSolutionViewEvent = Event<LandscapeViewer$LoadSolutionViewEventParameters>;
+  export type LandscapeViewer$LoadSolutionViewEvent = Event<
+    LandscapeViewer$LoadSolutionViewEventParameters,
+    LandscapeViewer
+  >;
 }
 
 declare module "sap/landvisz/LongTextField" {
@@ -7848,7 +7884,10 @@ declare module "sap/landvisz/OptionEntity" {
 
   export interface OptionEntity$SelectOptionEventParameters {}
 
-  export type OptionEntity$SelectOptionEvent = Event<OptionEntity$SelectOptionEventParameters>;
+  export type OptionEntity$SelectOptionEvent = Event<
+    OptionEntity$SelectOptionEventParameters,
+    OptionEntity
+  >;
 }
 
 declare module "sap/landvisz/OptionSource" {