@sapui5/ts-types 1.116.0 → 1.117.0

package/types/sap.insights.d.ts

@@ -1,21 +1,261 @@
-// For Library Version: 1.116.0
+// For Library Version: 1.117.0
 
-declare module "sap/insights/CardHelper" {
+declare namespace sap {
   /**
-   * @since 1.102
-   * @experimental (since 1.102)
-   *
-   * Provides functionality for Insight cards CRUD operations.
+   * SAP UI library: sap.insights
    */
-  interface CardHelper {}
-  const CardHelper: CardHelper;
-  export default CardHelper;
-}
+  namespace insights {
+    /**
+     * @experimental
+     *
+     * Interface required for classes that would like to consume cards using the `sap.insights.CardsChannel`.
+     */
+    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`.
+     */
+    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;
+    }
+
+    /**
+     * @experimental
+     *
+     * Public (experimental) interface of the sap.insights.UIService
+     */
+    interface UIService {
+      __implements__sap_insights_UIService: boolean;
+
+      /**
+       * @experimental
+       *
+       * Get a promise for the singleton instance of the cards channel.
+       */
+      getCardsChannel(): Promise<sap.insights.CardsChannel>;
+      /**
+       * @experimental
+       *
+       * Show preview for a given card
+       */
+      showCardPreview(
+        card: object,
+
+        bTransform?: boolean,
+
+        calledInternally?: boolean
+      ): Promise<void>;
+    }
+
+    /**
+     * @since 1.102
+     * @experimental (since 1.102)
+     *
+     * Provides functionality for Insight cards CRUD operations.
+     */
+    interface CardHelper {}
+
+    class CardsChannel extends sap.ui.base.Object {
+      /**
+       * 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, sap.insights.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(): sap.ui.base.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: sap.insights.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: sap.insights.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>;
+    }
+  }
 
-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 namespace sap {
   /**
@@ -3550,19 +3550,40 @@ declare namespace sap {
         SoftwareComponents = "SoftwareComponents",
       }
 
-      type ActionBar$SelectEvent = sap.ui.base.Event<ActionBar$SelectEventParameters>;
-
-      type DataContainer$SelectEvent = sap.ui.base.Event<DataContainer$SelectEventParameters>;
-
-      type EntityAction$PressEvent = sap.ui.base.Event<EntityAction$PressEventParameters>;
-
-      type EntityCustomAction$SelectEvent = sap.ui.base.Event<EntityCustomAction$SelectEventParameters>;
-
-      type HeaderList$PressEvent = sap.ui.base.Event<HeaderList$PressEventParameters>;
-
-      type IdentificationBar$SelectEvent = sap.ui.base.Event<IdentificationBar$SelectEventParameters>;
-
-      type SingleDataContainer$ClosedEvent = sap.ui.base.Event<SingleDataContainer$ClosedEventParameters>;
+      type ActionBar$SelectEvent = sap.ui.base.Event<
+        ActionBar$SelectEventParameters,
+        ActionBar
+      >;
+
+      type DataContainer$SelectEvent = sap.ui.base.Event<
+        DataContainer$SelectEventParameters,
+        DataContainer
+      >;
+
+      type EntityAction$PressEvent = sap.ui.base.Event<
+        EntityAction$PressEventParameters,
+        EntityAction
+      >;
+
+      type EntityCustomAction$SelectEvent = sap.ui.base.Event<
+        EntityCustomAction$SelectEventParameters,
+        EntityCustomAction
+      >;
+
+      type HeaderList$PressEvent = sap.ui.base.Event<
+        HeaderList$PressEventParameters,
+        HeaderList
+      >;
+
+      type IdentificationBar$SelectEvent = sap.ui.base.Event<
+        IdentificationBar$SelectEventParameters,
+        IdentificationBar
+      >;
+
+      type SingleDataContainer$ClosedEvent = sap.ui.base.Event<
+        SingleDataContainer$ClosedEventParameters,
+        SingleDataContainer
+      >;
     }
 
     interface $ConnectionEntitySettings extends sap.ui.core.$ControlSettings {
@@ -7777,17 +7798,35 @@ declare namespace sap {
       SOLUTION_VIEW = "SOLUTION_VIEW",
     }
 
-    type LandscapeEntity$MouseOverIdenIconEvent = sap.ui.base.Event<LandscapeEntity$MouseOverIdenIconEventParameters>;
-
-    type LandscapeEntity$StatusSelectEvent = sap.ui.base.Event<LandscapeEntity$StatusSelectEventParameters>;
-
-    type LandscapeEntity$TrackInfoPressEvent = sap.ui.base.Event<LandscapeEntity$TrackInfoPressEventParameters>;
-
-    type LandscapeViewer$CloseEvent = sap.ui.base.Event<LandscapeViewer$CloseEventParameters>;
-
-    type LandscapeViewer$LoadSolutionViewEvent = sap.ui.base.Event<LandscapeViewer$LoadSolutionViewEventParameters>;
-
-    type OptionEntity$SelectOptionEvent = sap.ui.base.Event<OptionEntity$SelectOptionEventParameters>;
+    type LandscapeEntity$MouseOverIdenIconEvent = sap.ui.base.Event<
+      LandscapeEntity$MouseOverIdenIconEventParameters,
+      LandscapeEntity
+    >;
+
+    type LandscapeEntity$StatusSelectEvent = sap.ui.base.Event<
+      LandscapeEntity$StatusSelectEventParameters,
+      LandscapeEntity
+    >;
+
+    type LandscapeEntity$TrackInfoPressEvent = sap.ui.base.Event<
+      LandscapeEntity$TrackInfoPressEventParameters,
+      LandscapeEntity
+    >;
+
+    type LandscapeViewer$CloseEvent = sap.ui.base.Event<
+      LandscapeViewer$CloseEventParameters,
+      LandscapeViewer
+    >;
+
+    type LandscapeViewer$LoadSolutionViewEvent = sap.ui.base.Event<
+      LandscapeViewer$LoadSolutionViewEventParameters,
+      LandscapeViewer
+    >;
+
+    type OptionEntity$SelectOptionEvent = sap.ui.base.Event<
+      OptionEntity$SelectOptionEventParameters,
+      OptionEntity
+    >;
   }
 
   interface IUI5DefineDependencyNames {