@microsoft/sp-adaptive-card-extension-base 1.21.0-beta.2 → 1.21.0

package/dist/index-internal.d.ts

@@ -79,11 +79,7 @@ export declare class AdaptiveCardExtensionContext extends BaseComponentContext {
      * Provides a sdk that gets current context of device. See {@link IPartialSDKs}
      */
     get sdks(): IPartialSDKs | undefined;
-    /**
-     * @beta
-     * Provides a promise that gets current location of the device
-     */
-    get location(): Promise<ILocation>;
+    /* Excluded from this release type: location */
     /* Excluded from this release type: _logEditCustomerPromiseFailure */
 }
 
@@ -252,17 +248,7 @@ export declare class BaseAdaptiveCardExtension<TProperties extends {} = {}, TSta
      * @virtual
      */
     protected get propertiesMetadata(): IAdaptiveCardExtensionPropertiesMetadata | undefined;
-    /**
-     * Indicates whether the ACE is rendering in async mode.
-     *
-     * @remarks
-     * If the ACE overrides this field to return true, then it needs to call renderCompleted API after the ACE finishes initializing.
-     *
-     * The default value is false.
-     *
-     * @beta
-     */
-    protected get isRenderAsync(): boolean;
+    /* Excluded from this release type: isRenderAsync */
     /**
      * Gets the custom state of the Adaptive Card Extension.
      *
@@ -317,41 +303,9 @@ export declare class BaseAdaptiveCardExtension<TProperties extends {} = {}, TSta
      * @virtual
      */
     protected loadPropertyPaneResources(): Promise<void>;
-    /**
-     * Override the default cache settings.
-     *
-     * @beta
-     * @virtual
-     */
-    protected getCacheSettings(): Partial<ICacheSettings>;
-    /**
-     * This virtual method returns a subset of the state object that will be cached by the client.
-     *
-     * @remarks If not overriden, this will return an empty object.
-     * @param state - A shallow clone of the AdaptiveCardExtension state object.
-     *
-     * @beta
-     * @virtual
-     */
-    protected getCachedState(state: TState): Partial<TState>;
-    /**
-     * Lifecycle method called when a notification is received for this Adaptive Card Extension.
-     *
-     * @remarks If the notification should be handled by this Adaptive Card Extension then a registered quick view id
-     * should be returned. Otherwise, returning undefined will result in the next, if any, Adaptive Card Extension
-     * to potentially handle the notification event.
-     *
-     * @remarks Only one Adaptive Card Extension can handle a notification event. If the event is handled,
-     * then propagation is finished.
-     *
-     * @param notificationArguments - The {@link INotificationArguments} for the current notification event.
-     *
-     * @returns A registered quick view id to open or undefined.
-     *
-     * @beta
-     * @virtual
-     */
-    onNotificationReceived(notificationArguments: Readonly<INotificationArguments<{}>>): INotificationResponse | undefined;
+    /* Excluded from this release type: getCacheSettings */
+    /* Excluded from this release type: getCachedState */
+    /* Excluded from this release type: onNotificationReceived */
     /**
      * Lifecycle method called before Action is passed to {@link IAdaptiveCardExtensionActionView.onAction}.
      *
@@ -432,19 +386,7 @@ export declare class BaseAdaptiveCardExtension<TProperties extends {} = {}, TSta
      * @virtual
      */
     onInit(): Promise<void>;
-    /**
-     * Lifecycle method called during initialization.
-     *
-     * @remarks Asynchronous data fetches should be started during this lifecycle. Rendering can either be dependent on the result
-     * or, if resolved immediately, a fetching data state can be rendered.
-     *
-     * @param cachedLoadParameters - Parameters containing the cached state object (see {@link BaseAdaptiveCardExtension.getCachedState}), which can be used to rehydrate the AdaptiveCardExtension.
-     * If undefined, the AdaptiveCardExtension was not cached or the cache expired.
-     *
-     * @beta
-     * @virtual
-     */
-    onInit(cachedLoadParameters?: ICachedLoadParameters): Promise<void>;
+    /* Excluded from this release type: onInit */
     /* Excluded from this release type: _initializeCardNavigator */
     /* Excluded from this release type: _initializeQuickViewNavigator */
     /**
@@ -493,19 +435,7 @@ export declare class BaseAdaptiveCardExtension<TProperties extends {} = {}, TSta
      */
     get isVisible(): boolean;
     set isVisible(value: boolean);
-    /**
-     * Lifecycle method that signifies ACE has finished loading.
-     * When this API is called, performance data will be generated.
-     * Depending on `didUpdate` parameter, end marker for the rendering lifecycle can change.
-     *   If an ACE received LKG data and does NOT need to update, render is completed when LKG is used.
-     *   If an ACE received LKG data and DOES need to update, render is completed when new render arguments are used.
-     *   If an ACE does not receive LKG data, render is completed when new render arguments are used.
-     *
-     * @param didUpdate - boolean value indicating if ACE has updated.
-     *
-     * @beta
-     */
-    renderCompleted(didUpdate: boolean): void;
+    /* Excluded from this release type: renderCompleted */
     private _endMarkForRenderComplete;
     private _resolveRenderCompleted;
     /**
@@ -638,16 +568,7 @@ export declare abstract class BaseAdaptiveCardQuickView<TProperties extends {} =
      * @virtual
      */
     onAction(action: IActionArguments): void;
-    /**
-     * @beta
-     *
-     * Error handler for Adaptive Card Actions.
-     *
-     * @param error - The {@link IActionErrorArguments} for the current event.
-     *
-     * @virtual
-     */
-    onActionError(error: IActionErrorArguments): void;
+    /* Excluded from this release type: onActionError */
 }
 
 /**
@@ -727,16 +648,7 @@ export declare abstract class BaseCardView<TProperties extends {} = {}, TState e
      * @virtual
      */
     onAction(action: IActionArguments): void;
-    /**
-     * @beta
-     *
-     * Error handler for Adaptive Card Actions.
-     *
-     * @param error - The {@link IActionErrorArguments} for the current event.
-     *
-     * @virtual
-     */
-    onActionError(error: IActionErrorArguments): void;
+    /* Excluded from this release type: onActionError */
 }
 
 /**
@@ -968,13 +880,7 @@ export declare function BasicCardView(configuration: IBasicTextCardViewConfigura
 
 /* Excluded from this release type: _BODY_SECONDARY_TEXT */
 
-/**
- * Predefined action ID for card view select action.
- * @remarks This ID is set for {@link IBaseOnBeforeActionArguments.id} when a card view select action is executed.
- *
- * @beta
- */
-export declare const CARD_VIEW_SELECT_ACTION_ID: string;
+/* Excluded from this release type: CARD_VIEW_SELECT_ACTION_ID */
 
 /* Excluded from this release type: _CardActionType */
 
@@ -1110,12 +1016,7 @@ export declare type GenericCardViewFooterParameters = CardViewActionsFooterParam
  */
 export declare type IActionArguments = ISubmitActionArguments | IShowCardActionArguments | ISelectMediaActionArguments | IGetLocationActionArguments | IExecuteActionArguments;
 
-/**
- * @beta
- */
-export declare interface IActionError {
-    code: string;
-}
+/* Excluded from this release type: IActionError */
 
 /**
  * The object passed to {@link IAdaptiveCardExtensionActionView.onActionError} when an error occured while executing Adaptive Card Action.
@@ -1142,14 +1043,7 @@ export declare interface IAdaptiveCardExtensionActionView extends BaseView {
      * @param action - The {@link IActionArguments} for the current event.
      */
     onAction: (action: IActionArguments) => void;
-    /**
-     * @beta
-     *
-     * Error handler for Adaptive Card Extension Actions.
-     *
-     * @param error - The {@link IActionErrorArguments} for the current event.
-     */
-    onActionError: (error: IActionErrorArguments) => void;
+    /* Excluded from this release type: onActionError */
 }
 
 /* Excluded from this release type: _IAdaptiveCardExtensionCache */
@@ -1204,6 +1098,8 @@ export declare interface IAdaptiveCardExtensionImage {
 
 /* Excluded from this release type: _IAdaptiveCardExtensionLoadContext */
 
+/* Excluded from this release type: IAdaptiveCardExtensionManifest */
+
 /**
  * This structure is used to define metadata for Adaptive Card Extension properties as a map of string to `IAdaptiveCardExtensionPropertiesMetadata`
  *
@@ -1333,21 +1229,9 @@ export declare interface IBaseActionArguments {
  *  @public
  */
 export declare interface IBaseActionErrorArguments {
-    /**
-     * The type of Adaptive Card Action thsat caused the error.
-     * @beta
-     */
-    type: 'Submit' | 'ShowCard' | 'Execute' | 'VivaAction.SelectMedia' | 'VivaAction.GetLocation' | 'VivaAction.ShowLocation';
-    /**
-     * The id specified in the Adaptive Card template
-     * @beta
-     */
-    id?: string;
-    /**
-     * The error thrown by the action
-     * @beta
-     */
-    error: IActionError;
+    /* Excluded from this release type: type */
+    /* Excluded from this release type: id */
+    /* Excluded from this release type: error */
 }
 
 /**
@@ -1425,17 +1309,7 @@ export declare interface IBaseCardParameters {
  * @privateRemarks - Each type that is not included in IActionArguments and used in IOnBeforeActionArguments must extend this interface.
  */
 export declare interface IBaseOnBeforeActionArguments {
-    /**
-     * The id specified in the card view action or Adaptive Card template
-     *
-     * @remarks This ID is automatically set to
-     * - {@link ICardButtonBase.id} if an action is triggered by card view button
-     * - {@link CARD_VIEW_SELECT_ACTION_ID} if an action is triggered by card view select action
-     * - Action id if an action is triggered by Quick View
-     *
-     * @beta
-     */
-    id?: string;
+    /* Excluded from this release type: id */
 }
 
 /* Excluded from this release type: _IBaseQuickViewRenderParameters */
@@ -1490,35 +1364,9 @@ export declare interface IBasicTextCardViewConfiguration extends Omit<ICardViewC
 
 /* Excluded from this release type: _IBot */
 
-/**
- * Parameters used to rehydrate the AdaptiveCardExtension during a cached load
- *
- * @beta
- * @remarks API under active development and not ready for use.
- */
-export declare interface ICachedLoadParameters {
-    state: any;
-    cardNavigatorState: string[];
-}
+/* Excluded from this release type: ICachedLoadParameters */
 
-/**
- * @beta
- */
-export declare interface ICacheSettings {
-    /**
-     * Whether cache is enabled. Default: true
-     */
-    isEnabled: boolean;
-    /**
-     * Expiry time in seconds. Default: 86400 seconds (24 hours)
-     */
-    expiryTimeInSeconds: number;
-    /**
-     * Returns the Card View used to generate the cached card.
-     * By default, the currently rendered Card View will be used to cache the card.
-     */
-    cachedCardView?: () => BaseCardView;
-}
+/* Excluded from this release type: ICacheSettings */
 
 /**
  * Type of handler for when a button is pressed.
@@ -2533,26 +2381,9 @@ export declare function ImageCardView(configuration: IImageCardViewConfiguration
 
 /* Excluded from this release type: _INavigationBarProperties */
 
-/**
- * The object passed to {@link BaseAdaptiveCardExtension.onNotificationReceived} when a notification is received.
- *
- * @beta
- */
-export declare interface INotificationArguments<T extends {}> {
-    version: Version;
-    data: T;
-}
+/* Excluded from this release type: INotificationArguments */
 
-/**
- * The object returned from {@link BaseAdaptiveCardExtension.onNotificationReceived} if it has handled the notification.
- *
- * @remarks ACE should return the registered quickViewId which it wants to display for the notification.
- *
- * @beta
- */
-export declare interface INotificationResponse {
-    quickViewId: string;
-}
+/* Excluded from this release type: INotificationResponse */
 
 /**
  * The object passed to {@link BaseAdaptiveCardExtension.onBeforeAction} when an Adaptive Card Action is executed.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/sp-adaptive-card-extension-base",
-  "version": "1.21.0-beta.2",
+  "version": "1.21.0",
   "description": "SharePoint Framework Adaptive Card Extensions",
   "license": "https://aka.ms/spfx/license",
   "homepage": "http://aka.ms/spfx",
@@ -18,25 +18,25 @@
     "@swc/helpers": "0.5.12",
     "adaptivecards": "2.11.2",
     "tslib": "2.3.1",
-    "@microsoft/sp-component-base": "1.21.0-beta.2",
-    "@microsoft/sp-core-library": "1.21.0-beta.2",
-    "@microsoft/sp-diagnostics": "1.21.0-beta.2",
-    "@microsoft/sp-http": "1.21.0-beta.2",
-    "@microsoft/sp-http-base": "1.21.0-beta.2",
-    "@microsoft/sp-loader": "1.21.0-beta.2",
-    "@microsoft/sp-lodash-subset": "1.21.0-beta.2",
-    "@microsoft/sp-property-pane": "1.21.0-beta.2",
-    "@microsoft/sp-module-interfaces": "1.21.0-beta.2"
+    "@microsoft/sp-core-library": "1.21.0",
+    "@microsoft/sp-component-base": "1.21.0",
+    "@microsoft/sp-diagnostics": "1.21.0",
+    "@microsoft/sp-http": "1.21.0",
+    "@microsoft/sp-http-base": "1.21.0",
+    "@microsoft/sp-loader": "1.21.0",
+    "@microsoft/sp-lodash-subset": "1.21.0",
+    "@microsoft/sp-module-interfaces": "1.21.0",
+    "@microsoft/sp-property-pane": "1.21.0"
   },
   "devDependencies": {
     "@rushstack/heft": "0.71.0",
     "eslint": "8.57.1",
     "jest-environment-jsdom": "29.5.0",
-    "@microsoft/sp-page-context": "1.21.0-beta.2",
+    "@microsoft/sp-page-context": "1.21.0",
+    "@microsoft/sp-webpart-base": "1.21.0",
     "@ms/odsp-analytics": "0.3.75",
     "@ms/sp-pages-core": "0.1.0",
     "@ms/sp-telemetry": "0.34.2",
-    "@microsoft/sp-webpart-base": "1.21.0-beta.2",
     "@ms/spfx-internal-web-build-rig": "0.1.0"
   },
   "scripts": {