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

package/{lib → lib-esm}/views/card/parameters/GenericTemplates.js

@@ -7,15 +7,18 @@ import { _textInputConfigurationToParameters } from '../../../components/TextInp
  * @param configuration - basic card view configuration.
  *
  * @public
- */
-export function BasicCardView(configuration) {
-    var cardBar = configuration.cardBar, header = configuration.header, footer = configuration.footer;
+ */ export function BasicCardView(configuration) {
+    const { cardBar, header, footer } = configuration;
     return {
         cardViewType: 'text',
         image: undefined,
         body: undefined,
-        cardBar: [_cardViewBarConfigurationToParameters(cardBar)],
-        header: [_textConfigurationToParameters(header)],
+        cardBar: [
+            _cardViewBarConfigurationToParameters(cardBar)
+        ],
+        header: [
+            _textConfigurationToParameters(header)
+        ],
         footer: _footerConfigurationToFooterParameters(footer)
     };
 }
@@ -24,15 +27,20 @@ export function BasicCardView(configuration) {
  * @param configuration - primary text card view configuration.
  *
  * @public
- */
-export function PrimaryTextCardView(configuration) {
-    var cardBar = configuration.cardBar, header = configuration.header, body = configuration.body, footer = configuration.footer;
+ */ export function PrimaryTextCardView(configuration) {
+    const { cardBar, header, body, footer } = configuration;
     return {
         cardViewType: 'text',
         image: undefined,
-        cardBar: [_cardViewBarConfigurationToParameters(cardBar)],
-        header: [_textConfigurationToParameters(header)],
-        body: [_textConfigurationToParameters(body)],
+        cardBar: [
+            _cardViewBarConfigurationToParameters(cardBar)
+        ],
+        header: [
+            _textConfigurationToParameters(header)
+        ],
+        body: [
+            _textConfigurationToParameters(body)
+        ],
         footer: _footerConfigurationToFooterParameters(footer)
     };
 }
@@ -41,14 +49,17 @@ export function PrimaryTextCardView(configuration) {
  * @param configuration - image card view configuration.
  *
  * @public
- */
-export function ImageCardView(configuration) {
-    var image = configuration.image, cardBar = configuration.cardBar, header = configuration.header, footer = configuration.footer;
+ */ export function ImageCardView(configuration) {
+    const { image, cardBar, header, footer } = configuration;
     return {
         cardViewType: 'text',
         image: image,
-        cardBar: [_cardViewBarConfigurationToParameters(cardBar)],
-        header: [_textConfigurationToParameters(header)],
+        cardBar: [
+            _cardViewBarConfigurationToParameters(cardBar)
+        ],
+        header: [
+            _textConfigurationToParameters(header)
+        ],
         body: undefined,
         footer: _footerConfigurationToFooterParameters(footer)
     };
@@ -58,15 +69,20 @@ export function ImageCardView(configuration) {
  * @param configuration - text input card view configuration.
  *
  * @public
- */
-export function TextInputCardView(configuration) {
-    var cardBar = configuration.cardBar, header = configuration.header, body = configuration.body, footer = configuration.footer;
+ */ export function TextInputCardView(configuration) {
+    const { cardBar, header, body, footer } = configuration;
     return {
         cardViewType: 'textInput',
         image: undefined,
-        cardBar: [_cardViewBarConfigurationToParameters(cardBar)],
-        header: [_textConfigurationToParameters(header)],
-        body: [_textInputConfigurationToParameters(body)],
+        cardBar: [
+            _cardViewBarConfigurationToParameters(cardBar)
+        ],
+        header: [
+            _textConfigurationToParameters(header)
+        ],
+        body: [
+            _textInputConfigurationToParameters(body)
+        ],
         footer: _footerConfigurationToFooterParameters(footer)
     };
 }
@@ -75,15 +91,20 @@ export function TextInputCardView(configuration) {
  * @param configuration - text input with image card view configuration.
  *
  * @public
- */
-export function TextInputImageCardView(configuration) {
-    var cardBar = configuration.cardBar, header = configuration.header, body = configuration.body, footer = configuration.footer, image = configuration.image;
+ */ export function TextInputImageCardView(configuration) {
+    const { cardBar, header, body, footer, image } = configuration;
     return {
         cardViewType: 'textInput',
         image: image,
-        cardBar: [_cardViewBarConfigurationToParameters(cardBar)],
-        header: [_textConfigurationToParameters(header)],
-        body: [_textInputConfigurationToParameters(body)],
+        cardBar: [
+            _cardViewBarConfigurationToParameters(cardBar)
+        ],
+        header: [
+            _textConfigurationToParameters(header)
+        ],
+        body: [
+            _textInputConfigurationToParameters(body)
+        ],
         footer: _footerConfigurationToFooterParameters(footer)
     };
 }
@@ -91,8 +112,7 @@ export function TextInputImageCardView(configuration) {
  * Transforms basic templates footer configuration to footer parameters.
  *
  * @internal
- */
-export function _footerConfigurationToFooterParameters(configuration) {
+ */ export function _footerConfigurationToFooterParameters(configuration) {
     //
     // In future we may want to validate footer configuration to avoid developers to provide disallowed components.
     // For example, they could do something like footer: [SomeUnsupportedComponent] as any
@@ -101,14 +121,19 @@ export function _footerConfigurationToFooterParameters(configuration) {
         return undefined;
     }
     if (Array.isArray(configuration)) {
-        return configuration.map(function (buttonConfiguration) {
+        return configuration.map((buttonConfiguration)=>{
             // we know for sure that array items are buttons here
             return _cardButtonConfigurationToParameters(buttonConfiguration);
         });
     }
     if (configuration.componentName === 'textInput') {
-        return [_textInputConfigurationToParameters(configuration)];
+        return [
+            _textInputConfigurationToParameters(configuration)
+        ];
     }
-    return [_cardButtonConfigurationToParameters(configuration)];
+    return [
+        _cardButtonConfigurationToParameters(configuration)
+    ];
 }
-//# sourceMappingURL=GenericTemplates.js.map
+
+//# sourceMappingURL=./GenericTemplates.js.map

package/lib-esm/views/interfaces/IAdaptiveCardExtensionActionView.js

@@ -0,0 +1,7 @@
+/**
+ * The interface describes members for views that can handle AC actions.
+ *
+ * @public
+ */ export { };
+
+//# sourceMappingURL=./IAdaptiveCardExtensionActionView.js.map

package/lib-esm/views/interfaces/IAdaptiveCardExtensionDataView.js

@@ -0,0 +1,7 @@
+/**
+ * The interface defines properties for view that specify configuration as data property.
+ *
+ * @public
+ */ export { };
+
+//# sourceMappingURL=./IAdaptiveCardExtensionDataView.js.map

package/lib-esm/views/interfaces/INavigationBarProperties.js

@@ -0,0 +1,5 @@
+/**
+ * @internal
+ */ export { };
+
+//# sourceMappingURL=./INavigationBarProperties.js.map

package/lib-esm/views/interfaces/IViewNavigator.js

@@ -0,0 +1,5 @@
+/**
+ * @internal
+ */ export { };
+
+//# sourceMappingURL=./IViewNavigator.js.map

package/lib-esm/views/navigator/QuickViewNavigator.js

@@ -0,0 +1,22 @@
+import { ViewNavigator } from './ViewNavigator';
+/**
+ * Manages a stack of Adaptive Card views for the Quick view.
+ *
+ * @remarks The top of the stack is the currently rendered view.
+ *
+ * @public
+ */ export class QuickViewNavigator extends ViewNavigator {
+    /**
+   * Closes the View.
+   */ close() {
+        this._closeQuickViewCallback();
+    }
+    /**
+   * @internal
+   */ constructor(handleStackChangedCallback, handleInitializeCallback, closeQuickViewCallback){
+        super(handleStackChangedCallback, handleInitializeCallback);
+        this._closeQuickViewCallback = closeQuickViewCallback;
+    }
+}
+
+//# sourceMappingURL=./QuickViewNavigator.js.map

package/lib-esm/views/navigator/ViewNavigator.js

@@ -0,0 +1,174 @@
+import { BaseAdaptiveCardQuickView } from '../quickView/BaseAdaptiveCardQuickView';
+import { ViewRegistry } from './ViewRegistry';
+import { isKeyboardFocusViewNavChangesKSActivated } from '../../common/Killswitches';
+/**
+ * A simple implemenation of the card view that is used while the defer load of
+ * a quickview is happening.
+ *
+ * @internal
+ */ export class EmptyQuickView extends BaseAdaptiveCardQuickView {
+    get data() {
+        return {};
+    }
+    get template() {
+        return {};
+    }
+}
+/**
+ * Manages a stack of views.
+ *
+ * @remarks The top of the stack represents the currently rendered view.
+ *
+ * @public
+ */ export class ViewNavigator {
+    /**
+   * Registers a new view.
+   *
+   * @remarks `initializer` must return an instance of a {@link BaseView} or a Promise of a {@link BaseView}.
+   *          The promise allows developers with large quickviews to defer / chunk in the quickview code on
+   *          demand
+   *
+   * @remarks `initializer` is not called until `id` is pushed onto the view stack.
+   *
+   * @remarks A View with a given `id` is only initialized once, and the instance is reused if it is pushed more than once
+   *
+   * @param id - Unique identifier for the view.
+   * @param initializer - Function that returns a new view - or a promise to a new view - which is only called if no view with the `id` already exists.
+   */ register(id, initializer) {
+        this._viewRegistry.register(id, initializer);
+    }
+    /**
+   * Pushes a new view to the top of the view stack.
+   *
+   * {@link BaseAdaptiveCardExtension.setState}, which will also trigger a render.
+   *
+   * @param id - Unique identifier for the view.
+   * @param skipUpdate - Whether to skip the update (and re-render) after pushing the new view.
+   */ push(id, skipUpdate = false) {
+        this._push(id);
+        this._handleStackChangedCallback(skipUpdate);
+    }
+    /**
+   * Replaces the top view with a new view.
+   *
+   * {@link BaseAdaptiveCardExtension.setState}, which will also trigger a render.
+   *
+   * @param id - Unique identifier for the view.
+   * @param skipUpdate - Whether to skip the update (and re-render) after replacing the current view.
+   */ replace(id, skipUpdate = false) {
+        this._pop();
+        this._push(id);
+        this._handleStackChangedCallback(skipUpdate);
+    }
+    /**
+   * If there is more than one View, pops the top View from the View stack.
+   *
+   * {@link BaseAdaptiveCardExtension.setState}, which will also trigger a render.
+   *
+   * @param skipUpdate - Whether to skip the update (and re-render) after popping the current View.
+   */ pop(skipUpdate = false) {
+        if (this.size > 1) {
+            this._pop();
+            this._handleStackChangedCallback(skipUpdate);
+        }
+    }
+    /**
+   * Current size of the View stack.
+   */ get size() {
+        return this._viewStack.length;
+    }
+    /**
+   * Get the id of the currently rendered View from the top of the View stack
+   * @remarks If the stack is empty, this will return undefined
+   */ get currentId() {
+        const size = this.size;
+        return size && isKeyboardFocusViewNavChangesKSActivated() ? this._viewStack[size - 1] : size ? this._viewStack[size - 1].id : undefined;
+    }
+    /**
+   * Currently rendered View from the top of the View stack
+   * @internal
+   */ get _currentView() {
+        const size = this.size;
+        if (isKeyboardFocusViewNavChangesKSActivated()) {
+            return this._viewCache.get(this._viewStack[size - 1]);
+        }
+        return {
+            ...this._viewStack[size - 1],
+            view: this._viewCache.get(this._viewStack[size - 1].id)
+        };
+    }
+    /**
+   *
+   * @internal
+   */ get viewStack() {
+        return this._viewStack;
+    }
+    /**
+   * Clear the stack.
+   *
+   * @internal
+   */ _clear() {
+        this._viewStack = [];
+    }
+    /**
+   * @internal
+   */ _forEach(callback) {
+        this._viewCache.forEach(callback);
+    }
+    /**
+   * Current size of the View registry.
+   *
+   * @internal
+   */ _getRegistrySize() {
+        return this._viewRegistry.size;
+    }
+    _push(id) {
+        const cachedView = this._viewCache.get(id);
+        if (cachedView === undefined) {
+            const viewInitializer = this._viewRegistry.consume(id);
+            let view = viewInitializer();
+            if (view instanceof Promise) {
+                const viewPromise = view;
+                viewPromise.then((value)=>{
+                    this._handleInitializeCallback(value);
+                    // update the cached view.
+                    this._viewCache.set(id, value);
+                    this._handleStackChangedCallback(false);
+                }).catch((e)=>{
+                    // eslint-disable-next-line no-console
+                    console.error('could not load quickview', e);
+                });
+                view = new EmptyQuickView();
+            } else {
+                view = view;
+            }
+            this._handleInitializeCallback(view);
+            this._viewCache.set(id, view);
+        }
+        if (isKeyboardFocusViewNavChangesKSActivated()) {
+            this._viewStack.push(id);
+        } else {
+            /**
+       * Prior to pushing the incoming view onto the `_viewStack`, set the last focused element of the current view.
+       * This stored reference allows the element to receive focus when navigating back to this view.
+       */ if (this.size > 0) {
+                this._viewStack[this.size - 1].focusElement = document.activeElement ?? undefined;
+            }
+            this._viewStack.push({
+                id: id
+            });
+        }
+    }
+    _pop() {
+        this._viewStack.pop();
+    }
+    constructor(handleStackChangedCallback, handleInitializeCallback){
+        this._handleStackChangedCallback = handleStackChangedCallback;
+        this._handleInitializeCallback = handleInitializeCallback;
+        this._viewStack = isKeyboardFocusViewNavChangesKSActivated() ? new Array() : new Array();
+        this._viewCache = new Map();
+        this._viewRegistry = new ViewRegistry();
+    }
+}
+
+//# sourceMappingURL=./ViewNavigator.js.map

package/lib-esm/views/navigator/ViewRegistry.js

@@ -0,0 +1,26 @@
+import { format } from '../../utilities/StringHelper';
+/**
+ * @internal
+ */ export class ViewRegistry {
+    register(id, initializer) {
+        if (!this._registeredCallbacks.has(id)) {
+            this._registeredCallbacks.set(id, initializer);
+        }
+    }
+    consume(id) {
+        const callback = this._registeredCallbacks.get(id);
+        if (!callback) {
+            throw new Error(format('View with id {0} must be registered before being used', id));
+        }
+        this._registeredCallbacks.delete(id);
+        return callback;
+    }
+    get size() {
+        return this._registeredCallbacks.size;
+    }
+    constructor(){
+        this._registeredCallbacks = new Map();
+    }
+}
+
+//# sourceMappingURL=./ViewRegistry.js.map

package/lib-esm/views/quickView/BaseAdaptiveCardQuickView.js

@@ -0,0 +1,65 @@
+import { _ES5CompatibleClass } from '@microsoft/sp-core-library';
+import { BaseQuickView } from './BaseQuickView';
+/**
+ * Base class for an Adaptive Card quick view.
+ *
+ * @remarks Views used to render the Quick view must inherit from this class.
+ *
+ * @public
+ */ export class BaseAdaptiveCardQuickView extends BaseQuickView {
+    /**
+   * The data used to render the Adaptive Card.
+   *
+   * @virtual
+   */ get data() {
+        return {};
+    }
+    /**
+   * An optional focus element to set focus when the view is rendered for accessibility purposes.
+   * @remarks If not overriden, the focus element defaulted to the first actionable element of the quick view.
+   *
+   * @virtual
+   */ get focusParameters() {
+        return undefined;
+    }
+    /**
+   * Action handler for Adaptive Card Actions.
+   *
+   * @param action - The {@link IActionArguments} for the current event.
+   *
+   * @virtual
+   */ onAction(action) {
+    // no-op
+    }
+    /**
+   * @beta
+   *
+   * Error handler for Adaptive Card Actions.
+   *
+   * @param error - The {@link IActionErrorArguments} for the current event.
+   *
+   * @virtual
+   */ onActionError(error) {
+    // no-op
+    }
+    constructor(...args){
+        super(...args);
+        /**
+   * @internal
+   */ this._viewType = 'AdaptiveCardQuickView';
+    }
+}
+/**
+ * Base class for an Adaptive Card quick view.
+ *
+ * @remarks Views used to render the Quick view must inherit from this class.
+ * @privateRemarks The class exists for backwards compat only
+ *
+ * @public
+ * @deprecated use {@link BaseAdaptiveCardQuickView} instead
+ */ export class BaseAdaptiveCardView extends BaseAdaptiveCardQuickView {
+}
+_ES5CompatibleClass(BaseAdaptiveCardQuickView);
+_ES5CompatibleClass(BaseAdaptiveCardView);
+
+//# sourceMappingURL=./BaseAdaptiveCardQuickView.js.map

package/lib-esm/views/quickView/BaseQuickView.js

@@ -0,0 +1,28 @@
+import { _ES5CompatibleClass } from '@microsoft/sp-core-library';
+import { BaseView } from '../base/BaseView';
+/**
+ * Base class for an Adaptive Card view.
+ *
+ * @public
+ */ export class BaseQuickView extends BaseView {
+    /**
+   * An optional external link to be displayed in the navigation bar above the Adaptive Card.
+   *
+   * @remarks If this method is not overriden or returns undefined, no link will be displayed.
+   *
+   * @virtual
+   */ get externalLink() {
+        return undefined;
+    }
+    /**
+   * An optional title to be displayed in the navigation bar above the Adaptive Card.
+   * @remarks If not overriden, the title displayed will be {@link BaseAdaptiveCardExtension.title}
+   *
+   * @virtual
+   */ get title() {
+        return '';
+    }
+}
+_ES5CompatibleClass(BaseQuickView);
+
+//# sourceMappingURL=./BaseQuickView.js.map

package/lib-esm/views/quickView/BaseWebQuickView.js

@@ -0,0 +1,49 @@
+import { _ES5CompatibleClass } from '@microsoft/sp-core-library';
+import { BaseQuickView } from './BaseQuickView';
+/**
+ * Base class for a Web Quick view.
+ *
+ * @public
+ */ export class BaseWebQuickView extends BaseQuickView {
+    /**
+   * @internal
+   */ _setDomElement(domElement) {
+        this._domElement = domElement;
+    }
+    /**
+   * Update the state of the Adaptive Card Extension.
+   *
+   * @remarks - This method will not trigger a re-render and only update the ACE with the new state.
+   *
+   * @param newState - The new state to set.
+   */ setState(newState) {
+        this._ace._internalSetState(newState, false);
+    }
+    /**
+   * Disposes the quick view.
+   *
+   * @remarks - This method is invoked when HTML Quick View's DOM element is removed from the Document.
+   * It will trigger when quick view modal is closed, or navigating between quick views.
+   *
+   * @virtual
+   */ dispose() {
+    /** no-op */ }
+    /**
+   * Reference to the DOM element that hosts this quick view.
+   * @remarks - DOM element will be undefined in the constructor and after the quick view is disposed.
+   */ get domElement() {
+        if (!this._domElement) {
+            throw new Error('Accessing DOM before initialized');
+        }
+        return this._domElement;
+    }
+    constructor(...args){
+        super(...args);
+        /**
+   * @internal
+   */ this._viewType = 'WebQuickView';
+    }
+}
+_ES5CompatibleClass(BaseWebQuickView);
+
+//# sourceMappingURL=./BaseWebQuickView.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/sp-adaptive-card-extension-base",
-  "version": "1.23.1",
+  "version": "1.24.0-beta.2",
   "description": "SharePoint Framework Adaptive Card Extensions",
   "homepage": "http://aka.ms/spfx",
   "license": "https://aka.ms/spfx/license",
@@ -11,32 +11,67 @@
     "node": ">=18.17.1 <19.0.0 || >=22.14.0 < 23.0.0"
   },
   "main": "lib-commonjs/index.js",
-  "module": "lib/index.js",
+  "module": "lib-esm/index.js",
   "typings": "dist/index-internal.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index-internal.d.ts",
+      "import": "./lib-esm/index.js",
+      "require": "./lib-commonjs/index.js"
+    },
+    "./lib/*.resx": "./lib-esm/*.resx.json",
+    "./lib/*": {
+      "types": "./lib-dts/*.d.ts",
+      "import": "./lib-esm/*.js",
+      "require": "./lib-commonjs/*.js"
+    },
+    "./lib-commonjs/*.resx": "./lib-esm/*.resx.json",
+    "./lib-commonjs/*": {
+      "types": "./lib-dts/*.d.ts",
+      "import": "./lib-esm/*.js",
+      "require": "./lib-commonjs/*.js"
+    },
+    "./dist/test-api": {
+      "types": "./dist/test-api/index.d.ts",
+      "import": "./lib-esm/test-api/index.js",
+      "require": "./lib-commonjs/test-api/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "typesVersions": {
+    "*": {
+      "lib/*": [
+        "lib-dts/*"
+      ],
+      "dist/test-api": [
+        "dist/test-api/index"
+      ]
+    }
+  },
   "dependencies": {
-    "@microsoft/teams-js-v2": "npm:@microsoft/teams-js@2.36.0",
+    "@microsoft/teams-js-v2": "npm:@microsoft/teams-js@2.53.0",
     "@swc/helpers": "^0.5.12",
     "adaptivecards": "2.11.2",
     "swiper": "8.4.7",
     "tslib": "2.3.1",
-    "@microsoft/sp-component-base": "1.23.1",
-    "@microsoft/sp-core-library": "1.23.1",
-    "@microsoft/sp-http": "1.23.1",
-    "@microsoft/sp-http-base": "1.23.1",
-    "@microsoft/sp-loader": "1.23.1",
-    "@microsoft/sp-diagnostics": "1.23.1",
-    "@microsoft/sp-lodash-subset": "1.23.1",
-    "@microsoft/sp-module-interfaces": "1.23.1",
-    "@microsoft/sp-property-pane": "1.23.1"
+    "@microsoft/sp-diagnostics": "1.24.0-beta.2",
+    "@microsoft/sp-core-library": "1.24.0-beta.2",
+    "@microsoft/sp-component-base": "1.24.0-beta.2",
+    "@microsoft/sp-http": "1.24.0-beta.2",
+    "@microsoft/sp-http-base": "1.24.0-beta.2",
+    "@microsoft/sp-lodash-subset": "1.24.0-beta.2",
+    "@microsoft/sp-module-interfaces": "1.24.0-beta.2",
+    "@microsoft/sp-loader": "1.24.0-beta.2",
+    "@microsoft/sp-property-pane": "1.24.0-beta.2"
   },
   "devDependencies": {
     "@rushstack/heft": "1.2.17",
     "eslint": "9.37.0",
-    "jest-environment-jsdom": "29.5.0",
-    "@microsoft/sp-page-context": "1.23.1",
-    "@microsoft/sp-webpart-base": "1.23.1",
-    "@msinternal/odsp-analytics": "1.0.12",
-    "@msinternal/sp-telemetry": "0.35.145",
+    "jest-environment-jsdom": "30.3.0",
+    "@microsoft/sp-webpart-base": "1.24.0-beta.2",
+    "@microsoft/sp-page-context": "1.24.0-beta.2",
+    "@msinternal/odsp-analytics": "1.0.26",
+    "@msinternal/sp-telemetry": "1.0.73",
     "@msinternal/spfx-internal-web-build-rig": "0.1.0"
   },
   "scripts": {

package/dist/index.js

@@ -1,8 +0,0 @@
-// THIS FILE IS PART OF THE TEST-API PATTERN.
-//
-// It is copied by a rule from config/post-copy.json during the build.
-// You should not add it to Git.
-//
-// For documentation, please see sp-core-library/includes/test-api-pattern/README.md
-
-module.exports = require('../lib-commonjs/index');