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

package/lib-esm/views/card/BaseComponentsCardView.js

@@ -0,0 +1,43 @@
+import { _ES5CompatibleClass } from '@microsoft/sp-core-library';
+import { BaseCardView } from './BaseCardView';
+import { CardViewParametersProcessors } from './parameters/CardViewParametersProcessors';
+/**
+ * Base class for an component-based Card views.
+ *
+ * @public
+ */ export class BaseComponentsCardView extends BaseCardView {
+    /**
+   * @internal
+   */ _getCardViewParameters() {
+        let parameters = this.cardViewParameters;
+        if (!this.cardViewParameters.cardBar[0].title || !this.cardViewParameters.cardBar[0].icon) {
+            parameters = {
+                ...parameters,
+                cardBar: [
+                    this._ensureCardBarParameters(parameters.cardBar[0])
+                ]
+            };
+        }
+        return CardViewParametersProcessors.execute(parameters.cardViewType, parameters, {
+            cardSize: this.cardSize
+        });
+    }
+    /**
+   * Ensures that the card bar parameters are valid. If there is no title or icon, the title and icon from the ACE are used.
+   *
+   * @internal
+   */ _ensureCardBarParameters(cardBar) {
+        return {
+            ...cardBar,
+            title: cardBar.title || this._ace.title,
+            icon: {
+                url: cardBar.icon?.url || this._ace.iconProperty,
+                altText: cardBar.icon?.altText,
+                _urlFallback: cardBar.icon?._urlFallback
+            }
+        };
+    }
+}
+_ES5CompatibleClass(BaseComponentsCardView);
+
+//# sourceMappingURL=./BaseComponentsCardView.js.map

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

@@ -1,4 +1,3 @@
-import { __extends } from "tslib";
 import { _ES5CompatibleClass } from '@microsoft/sp-core-library';
 import { imageL1Template } from '../../ac-template/imageL1Template';
 import { imageL1TemplateSelectAction } from '../../ac-template/imageL1TemplateSelectAction';
@@ -15,23 +14,12 @@ import { ImageCardView } from './parameters/GenericTemplates';
  *  - Zero buttons in the `Medium` Card size, up to two buttons in `Large` Card size
  *
  * @public
- */
-var BaseImageCardView = /** @class */ (function (_super) {
-    __extends(BaseImageCardView, _super);
-    function BaseImageCardView() {
-        var _this = _super !== null && _super.apply(this, arguments) || this;
-        /**
-         * @internal
-         */
-        _this._templateType = 'Image';
-        return _this;
-    }
+ */ export class BaseImageCardView extends BaseTemplateCardView {
     /**
-     * @internal
-     */
-    BaseImageCardView.prototype._getCardViewParameters = function () {
-        var data = this.data;
-        var parameters = ImageCardView({
+   * @internal
+   */ _getCardViewParameters() {
+        const data = this.data;
+        const parameters = ImageCardView({
             image: {
                 url: data.imageUrl,
                 altText: data.iconAltText,
@@ -47,24 +35,24 @@ var BaseImageCardView = /** @class */ (function (_super) {
         // updating the cardViewType to track "old" templates
         parameters.cardViewType = 'image-template';
         return parameters;
-    };
-    Object.defineProperty(BaseImageCardView.prototype, "template", {
+    }
+    /**
+   * Returns the Adaptive Card template for the {@link BaseImageCardView}.
+   *
+   * @public
+   * @sealed
+   *
+   * @deprecated template property is deprecated for card views.
+   */ get template() {
+        return this._getTemplate(imageL1Template, imageL1TemplateSelectAction);
+    }
+    constructor(...args){
+        super(...args);
         /**
-         * Returns the Adaptive Card template for the {@link BaseImageCardView}.
-         *
-         * @public
-         * @sealed
-         *
-         * @deprecated template property is deprecated for card views.
-         */
-        get: function () {
-            return this._getTemplate(imageL1Template, imageL1TemplateSelectAction);
-        },
-        enumerable: false,
-        configurable: true
-    });
-    return BaseImageCardView;
-}(BaseTemplateCardView));
-export { BaseImageCardView };
+   * @internal
+   */ this._templateType = 'Image';
+    }
+}
 _ES5CompatibleClass(BaseImageCardView);
-//# sourceMappingURL=BaseImageCardView.js.map
+
+//# sourceMappingURL=./BaseImageCardView.js.map

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

@@ -1,4 +1,3 @@
-import { __extends } from "tslib";
 import { _ES5CompatibleClass } from '@microsoft/sp-core-library';
 import { primaryTextL1Template } from '../../ac-template/primaryTextL1Template';
 import { primaryTextL1TemplateSelectAction } from '../../ac-template/primaryTextL1TemplateSelectAction';
@@ -16,23 +15,12 @@ import { PrimaryTextCardView } from './parameters/GenericTemplates';
  *
  *
  * @public
- */
-var BasePrimaryTextCardView = /** @class */ (function (_super) {
-    __extends(BasePrimaryTextCardView, _super);
-    function BasePrimaryTextCardView() {
-        var _this = _super !== null && _super.apply(this, arguments) || this;
-        /**
-         * @internal
-         */
-        _this._templateType = 'PrimaryText';
-        return _this;
-    }
+ */ export class BasePrimaryTextCardView extends BaseTemplateCardView {
     /**
-     * @internal
-     */
-    BasePrimaryTextCardView.prototype._getCardViewParameters = function () {
-        var data = this.data;
-        var parameters = PrimaryTextCardView({
+   * @internal
+   */ _getCardViewParameters() {
+        const data = this.data;
+        const parameters = PrimaryTextCardView({
             cardBar: this._getCardBarConfiguration(),
             header: {
                 componentName: 'text',
@@ -47,23 +35,23 @@ var BasePrimaryTextCardView = /** @class */ (function (_super) {
         // updating the cardViewType to track "old" templates
         parameters.cardViewType = 'primaryText-template';
         return parameters;
-    };
-    Object.defineProperty(BasePrimaryTextCardView.prototype, "template", {
+    }
+    /**
+   * Returns the Adaptive Card template for the {@link BasePrimaryTextCardView}.
+   *
+   * @public
+   * @sealed
+   * @deprecated template property is deprecated for card views.
+   */ get template() {
+        return this._getTemplate(primaryTextL1Template, primaryTextL1TemplateSelectAction);
+    }
+    constructor(...args){
+        super(...args);
         /**
-         * Returns the Adaptive Card template for the {@link BasePrimaryTextCardView}.
-         *
-         * @public
-         * @sealed
-         * @deprecated template property is deprecated for card views.
-         */
-        get: function () {
-            return this._getTemplate(primaryTextL1Template, primaryTextL1TemplateSelectAction);
-        },
-        enumerable: false,
-        configurable: true
-    });
-    return BasePrimaryTextCardView;
-}(BaseTemplateCardView));
-export { BasePrimaryTextCardView };
+   * @internal
+   */ this._templateType = 'PrimaryText';
+    }
+}
 _ES5CompatibleClass(BasePrimaryTextCardView);
-//# sourceMappingURL=BasePrimaryTextCardView.js.map
+
+//# sourceMappingURL=./BasePrimaryTextCardView.js.map

package/lib-esm/views/card/BaseTemplateCardView.js

@@ -0,0 +1,65 @@
+import { _ES5CompatibleClass } from '@microsoft/sp-core-library';
+import { cloneDeep } from '@microsoft/sp-lodash-subset';
+import { BaseCardView } from './BaseCardView';
+import { _cardButtonToConfiguration } from '../../components/CardButtonComponent';
+/**
+ * Primitive base class for template-based Card views.
+ *
+ * @remarks No third-party Card views should inherit from this class.
+ *
+ * @public
+ * @sealed
+ */ export class BaseTemplateCardView extends BaseCardView {
+    /**
+   * The buttons displayed on the Card.
+   *
+   * @remarks Some Card view templates will restrict how many buttons can be displayed depending on
+   * various factors. See the documentation for the respective base Card View class for specific details.
+   *
+   * @virtual
+   */ get cardButtons() {
+        return undefined;
+    }
+    /**
+   * @internal
+   */ _getTemplate(template, cardSelectionTemplate) {
+        return cloneDeep(this.onCardSelection ? cardSelectionTemplate : template);
+    }
+    /**
+   * Transforms cardButtons to GenericCardViewFooterConfiguration
+   *
+   * @internal
+   */ _getGenericCardViewFooterConfiguration() {
+        const cardButtons = this.cardButtons;
+        if (!cardButtons) {
+            return undefined;
+        }
+        if (cardButtons.length === 1) {
+            return _cardButtonToConfiguration(cardButtons[0]);
+        }
+        if (cardButtons.length > 2) {
+            return cardButtons.splice(0, 2).map((button)=>_cardButtonToConfiguration(button));
+        } else {
+            return cardButtons.map((button)=>_cardButtonToConfiguration(button));
+        }
+    }
+    /**
+   * Gets the card bar configuration based on card parameters (data)
+   *
+   * @internal
+   */ _getCardBarConfiguration() {
+        const { title, iconProperty, iconAltText, _iconPropertyFallback } = this.data;
+        return {
+            componentName: 'cardBar',
+            title: title || this._ace.title,
+            icon: {
+                url: iconProperty || this._ace.iconProperty,
+                altText: iconAltText,
+                _urlFallback: _iconPropertyFallback
+            }
+        };
+    }
+}
+_ES5CompatibleClass(BaseTemplateCardView);
+
+//# sourceMappingURL=./BaseTemplateCardView.js.map

package/lib-esm/views/card/DefaultCardView.js

@@ -0,0 +1,19 @@
+import { BaseBasicCardView } from './BaseBasicCardView';
+/**
+ * @internal
+ */ export class DefaultCardView extends BaseBasicCardView {
+    get data() {
+        return {
+            primaryText: this._primaryText
+        };
+    }
+    constructor(primaryText){
+        super();
+        /**
+   * @internal
+   */ this._templateType = 'Basic';
+        this._primaryText = primaryText;
+    }
+}
+
+//# sourceMappingURL=./DefaultCardView.js.map

package/lib-esm/views/card/parameters/BaseParameters.js

@@ -0,0 +1,7 @@
+/**
+ * The actions-only footer configuration for the card view.
+ *
+ * @public
+ */ export { };
+
+//# sourceMappingURL=./BaseParameters.js.map

package/lib-esm/views/card/parameters/CardViewParametersProcessors.js

@@ -0,0 +1,30 @@
+/**
+ * The card view parameters processors.
+ * @remarks - The processors are used to process the card view parameters before rendering.
+ *
+ * @internal
+ */ export class CardViewParametersProcessors {
+    /**
+   * To register a processor for a key.
+   */ static register(key, processor) {
+        this._processors.set(key, processor);
+    }
+    /**
+   * To execute a processor for a key.
+   * @remarks - If no processor is registered for the key, the parameters are returned as is.
+   * @param key - The key.
+   * @param parameters - The card view parameters to process.
+   * @param context - The context for the processor.
+   */ static execute(key, parameters, context) {
+        if (this._processors.has(key)) {
+            const processor = this._processors.get(key);
+            return processor(parameters, context);
+        }
+        return parameters;
+    }
+}
+/**
+   * The registered processors map.
+   */ CardViewParametersProcessors._processors = new Map();
+
+//# sourceMappingURL=./CardViewParametersProcessors.js.map

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

@@ -1,4 +1,3 @@
-import { __assign } from "tslib";
 import { _preProcessLineChartParameters, _lineConfigurationToParameters } from '../../../components/LineChartComponent';
 import { CardViewParametersProcessors } from './CardViewParametersProcessors';
 import { _textConfigurationToParameters } from '../../../components/TextComponent';
@@ -14,9 +13,8 @@ import { _preProcessBarChartParameters } from '../../../components/BarChartCompo
  * @returns - line chart card view parameters.
  *
  * @public
- */
-export function LineChartCardView(configuration) {
-    return _DataVisualizationCardView(configuration, (_lineConfigurationToParameters));
+ */ export function LineChartCardView(configuration) {
+    return _DataVisualizationCardView(configuration, _lineConfigurationToParameters);
 }
 /**
  * Helper method to create a pie chart card view
@@ -25,8 +23,7 @@ export function LineChartCardView(configuration) {
  * @returns - pie chart card view parameters.
  *
  * @public
- */
-export function PieChartCardView(configuration) {
+ */ export function PieChartCardView(configuration) {
     return _DataVisualizationCardView(configuration, _pieConfigurationToParameters);
 }
 /**
@@ -36,8 +33,7 @@ export function PieChartCardView(configuration) {
  * @returns - bar chart card view parameters.
  *
  * @public
- */
-export function BarChartCardView(configuration) {
+ */ export function BarChartCardView(configuration) {
     return _DataVisualizationCardView(configuration, _barConfigurationToParameters);
 }
 /**
@@ -47,33 +43,40 @@ export function BarChartCardView(configuration) {
  * @returns - card view parameters.
  *
  * @internal
- */
-function _DataVisualizationCardView(configuration, componentConfigurationToParameters) {
-    var cardBar = configuration.cardBar, header = configuration.header, body = configuration.body, footer = configuration.footer;
-    var bodyParameters;
+ */ function _DataVisualizationCardView(configuration, componentConfigurationToParameters) {
+    const { cardBar, header, body, footer } = configuration;
+    let bodyParameters;
     if (!Array.isArray(body)) {
-        bodyParameters = [componentConfigurationToParameters(body)];
-    }
-    else if (body.length === 1) {
-        bodyParameters = [componentConfigurationToParameters(body[0])];
-    }
-    else {
-        bodyParameters = [_textConfigurationToParameters(body[0]), componentConfigurationToParameters(body[1])];
+        bodyParameters = [
+            componentConfigurationToParameters(body)
+        ];
+    } else if (body.length === 1) {
+        bodyParameters = [
+            componentConfigurationToParameters(body[0])
+        ];
+    } else {
+        bodyParameters = [
+            _textConfigurationToParameters(body[0]),
+            componentConfigurationToParameters(body[1])
+        ];
     }
     return {
         cardViewType: 'dataVisualization',
         image: undefined,
-        cardBar: [_cardViewBarConfigurationToParameters(cardBar)],
-        header: header && [_textConfigurationToParameters(header)],
+        cardBar: [
+            _cardViewBarConfigurationToParameters(cardBar)
+        ],
+        header: header && [
+            _textConfigurationToParameters(header)
+        ],
         body: bodyParameters,
         footer: footer && _footerConfigurationToFooterParameters(footer)
     };
 }
 /**
  * @internal
- */
-function _dataVisualizationComponentProcessor(parameters, hasHeader, hasDescription, hasFooter, cardSize) {
-    switch (parameters.dataVisualizationKind) {
+ */ function _dataVisualizationComponentProcessor(parameters, hasHeader, hasDescription, hasFooter, cardSize) {
+    switch(parameters.dataVisualizationKind){
         case 'line':
             return _preProcessLineChartParameters(parameters, hasHeader, hasDescription, hasFooter, cardSize);
         case 'pie':
@@ -86,26 +89,28 @@ function _dataVisualizationComponentProcessor(parameters, hasHeader, hasDescript
 }
 /**
  * @internal
- */
-export var _dataVisualizationCardViewParametersProcessor = function (cardViewParameters, context) {
-    var params = __assign({}, cardViewParameters);
+ */ export const _dataVisualizationCardViewParametersProcessor = (cardViewParameters, context)=>{
+    const params = {
+        ...cardViewParameters
+    };
     if (context.cardSize === 'Medium') {
         params.header = undefined;
         params.footer = undefined;
         if (params.body.length === 2) {
-            params.body = [params.body[1]];
+            params.body = [
+                params.body[1]
+            ];
         }
     }
-    var header = params.header, body = params.body, footer = params.footer;
-    var hasHeader = !!(header === null || header === void 0 ? void 0 : header.length);
-    var hasDescription = params.body.length === 2;
-    var hasFooter = !!(footer === null || footer === void 0 ? void 0 : footer.length);
+    const { header, body, footer } = params;
+    const hasHeader = !!header?.length;
+    const hasDescription = params.body.length === 2;
+    const hasFooter = !!footer?.length;
     if (body.length === 1) {
         params.body = [
             _dataVisualizationComponentProcessor(body[0], hasHeader, hasDescription, hasFooter, context.cardSize)
         ];
-    }
-    else {
+    } else {
         params.body = [
             body[0],
             _dataVisualizationComponentProcessor(body[1], hasHeader, hasDescription, hasFooter, context.cardSize)
@@ -114,4 +119,5 @@ export var _dataVisualizationCardViewParametersProcessor = function (cardViewPar
     return params;
 };
 CardViewParametersProcessors.register('dataVisualization', _dataVisualizationCardViewParametersProcessor);
-//# sourceMappingURL=DataVisualizationParameters.js.map
+
+//# sourceMappingURL=./DataVisualizationParameters.js.map

package/lib-esm/views/card/parameters/FocusedParameters.js

@@ -0,0 +1,58 @@
+import { _cardViewBarConfigurationToParameters } from '../../../components/CardBarComponent';
+import { _cardViewPoweredByConfigurationToParameters } from '../../../components/PoweredByComponent';
+import { _searchBoxConfigurationToParameters } from '../../../components/SearchBoxComponent';
+import { _searchFooterConfigurationToParameters } from '../../../components/SearchFooterComponent';
+import { _textConfigurationToParameters } from '../../../components/TextComponent';
+import { _promptsSetConfigurationToParameters } from '../../../components/PromptsSetComponent';
+/**
+ * Helper method to create a Search Card View.
+ * @param configuration - search card view configuration.
+ *
+ * @public
+ */ export function SearchCardView(configuration) {
+    const { cardBar, header, body, footer } = configuration;
+    return {
+        cardViewType: 'search',
+        image: undefined,
+        cardBar: [
+            _cardViewBarConfigurationToParameters(cardBar)
+        ],
+        header: [
+            _textConfigurationToParameters(header)
+        ],
+        body: [
+            _searchBoxConfigurationToParameters(body)
+        ],
+        footer: footer ? [
+            _searchFooterConfigurationToParameters(footer)
+        ] : undefined
+    };
+}
+/**
+ * Helper method to create a Copilot-powered Card View.
+ * @param configuration - copilot powered card view configuration.
+ *
+ * @internal
+ */ export function CopilotCardView(configuration) {
+    const { cardBar, header, body, footer } = configuration;
+    return {
+        cardViewType: 'copilot',
+        cardBar: [
+            _cardViewBarConfigurationToParameters(cardBar)
+        ],
+        image: undefined,
+        header: [
+            _textConfigurationToParameters(header)
+        ],
+        body: body.componentName === 'promptsSet' ? [
+            _promptsSetConfigurationToParameters(body)
+        ] : [
+            _textConfigurationToParameters(body)
+        ],
+        footer: [
+            _cardViewPoweredByConfigurationToParameters(footer)
+        ]
+    };
+}
+
+//# sourceMappingURL=./FocusedParameters.js.map