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

package/{lib → lib-esm}/components/CardButtonComponent.js

@@ -1,16 +1,16 @@
-import { __assign } from "tslib";
 /**
  * @internal
- */
-export function _cardButtonConfigurationToParameters(configuration) {
-    return __assign(__assign({}, configuration), { componentName: 'cardButton' });
+ */ export function _cardButtonConfigurationToParameters(configuration) {
+    return {
+        ...configuration,
+        componentName: 'cardButton'
+    };
 }
 /**
  * Helper function to convert ICardButton to ICardButtonConfiguration
  *
  * @internal
- */
-export function _cardButtonToConfiguration(cardButton) {
+ */ export function _cardButtonToConfiguration(cardButton) {
     return {
         componentName: 'cardButton',
         title: cardButton.title,
@@ -25,8 +25,7 @@ export function _cardButtonToConfiguration(cardButton) {
  * @privateRemarks remove when IDC implements support for ACE Components
  *
  * @internal
- */
-export function _cardButtonParametersToCardButton(parameters) {
+ */ export function _cardButtonParametersToCardButton(parameters) {
     return {
         title: parameters.title,
         action: parameters.action,
@@ -34,4 +33,5 @@ export function _cardButtonParametersToCardButton(parameters) {
         id: parameters.id
     };
 }
-//# sourceMappingURL=CardButtonComponent.js.map
+
+//# sourceMappingURL=./CardButtonComponent.js.map

package/lib-esm/components/DataVisualizationComponent.js

@@ -0,0 +1,26 @@
+/**
+ * Chart is rendered on right side (fixed layout) if atleast 2 of the 3 card elements are present: Header, Footer, Description
+ *
+ * @internal
+ */ export function _getDataVisualizationComponentPosition(hasHeader, hasDescription, hasFooter) {
+    return hasHeader && hasFooter || hasDescription && (hasHeader || hasFooter) ? 'fixed' : 'body';
+}
+export function _getCartesianChartLayoutProperties(parameters, hasHeader, hasDescription, hasFooter, cardSize) {
+    // Chart is rendered on right side if atleast 2 of the 3 are present: Header, Footer, Description
+    const position = _getDataVisualizationComponentPosition(hasHeader, hasDescription, hasFooter);
+    // Width of the chart is half of the large card if it is in fixed layout which is approximately equal as Medium Card
+    const isMediumSizedChart = position === 'fixed' || cardSize === 'Medium';
+    // if chart is in body and at least one of the 3 (header, footer, description) is present, then it is partial height, max limit of yLabels is 3
+    // Height of chart is full in case of fixed layout or medium cards
+    const isPartialHeightChart = (hasHeader || hasFooter || hasDescription) && !isMediumSizedChart;
+    // Show legend only for full-sized charts with multiple series, where at least one series has a name.
+    const showLegend = !isMediumSizedChart && !isPartialHeightChart && parameters.series.length > 1 && parameters.series.some((s)=>'name' in s);
+    return {
+        isMediumSizedChart,
+        isPartialHeightChart,
+        showLegend,
+        position
+    };
+}
+
+//# sourceMappingURL=./DataVisualizationComponent.js.map

package/lib-esm/components/ICardButtonBase.js

@@ -0,0 +1,7 @@
+/**
+ * Base properties for the buttons used in different ACE card view components, such as Text Input and Search Box and Card Button.
+ *
+ * @public
+ */ export { };
+
+//# sourceMappingURL=./ICardButtonBase.js.map

package/lib-esm/components/LineChartComponent.js

@@ -0,0 +1,29 @@
+import { _getCartesianChartLayoutProperties } from './DataVisualizationComponent';
+/**
+ * Convert line chart configuration to data visualization parameters.
+ *
+ * @internal
+ */ export function _lineConfigurationToParameters(configuration) {
+    return configuration;
+}
+export function _preProcessLineChartParameters(parameters, hasHeader, hasDescription, hasFooter, cardSize) {
+    const params = {
+        ...parameters
+    };
+    // If at least one of series[].data[].x is of type Date, set type to 'date'
+    const type = params.series.some((series)=>series.data.some((data)=>data.x instanceof Date)) ? 'date' : 'number';
+    const { isMediumSizedChart, isPartialHeightChart, showLegend, position } = _getCartesianChartLayoutProperties(params, hasHeader, hasDescription, hasFooter, cardSize);
+    if (isMediumSizedChart && params.series.length > 1) {
+        params.series = params.series.slice(0, 1);
+    }
+    params._metadata = {
+        type,
+        xLabelsCount: isMediumSizedChart ? 3 : 6,
+        yLabelsCount: isPartialHeightChart ? 3 : 4,
+        showLegend,
+        position
+    };
+    return params;
+}
+
+//# sourceMappingURL=./LineChartComponent.js.map

package/lib-esm/components/PieChartComponent.js

@@ -0,0 +1,115 @@
+import { _getDataVisualizationComponentPosition } from './DataVisualizationComponent';
+/**
+ * Convert pie chart configuration to data visualization parameters.
+ *
+ * @internal
+ */ export function _pieConfigurationToParameters(configuration) {
+    return configuration;
+}
+/**
+ * Function to calculate the metadata properties for the pie chart based on card layout.
+ */ function _getPieChartProperties(cardSize, position, isPartialHeightCard) {
+    if (position === 'fixed') {
+        return {
+            pieChartSize: 'fixed',
+            maxCategories: 8,
+            maxLabels: 4
+        };
+    } else if (isPartialHeightCard) {
+        return {
+            pieChartSize: 'partial',
+            maxCategories: 6,
+            maxLabels: 2
+        };
+    } else if (cardSize === 'Medium') {
+        return {
+            pieChartSize: 'medium',
+            maxCategories: 6,
+            maxLabels: 2
+        };
+    } else {
+        return {
+            pieChartSize: 'full',
+            maxCategories: 10,
+            maxLabels: 6
+        };
+    }
+}
+function _limitPieDataByMaxCategories(series, maxCategories) {
+    if (series.data.length <= maxCategories) {
+        return series;
+    }
+    const limitedData = series.data.slice(0, maxCategories - 1);
+    const others = {
+        x: 'Others',
+        y: series.data.slice(maxCategories - 1).reduce((sum, dataPoint)=>sum + dataPoint.y, 0),
+        color: '#EDEDED',
+        showLabel: false
+    };
+    return {
+        ...series,
+        data: [
+            ...limitedData,
+            others
+        ]
+    };
+}
+function _createDataLabels(series, pieChartSize, maxLabels, showLabelValue) {
+    const sumY = series.data.reduce((sum, dataPoint)=>sum + dataPoint.y, 0);
+    let labelsCount = 0;
+    const dataPointsWithLabels = series.data.map((dataPoint)=>{
+        if (labelsCount < maxLabels && dataPoint.showLabel === showLabelValue) {
+            labelsCount++;
+            return {
+                ...dataPoint,
+                _dataLabel: pieChartSize === 'fixed' || pieChartSize === 'medium' ? `${(dataPoint.y / sumY * 100).toFixed(0)}%` : `${dataPoint.x.substring(0, 3)}:${(dataPoint.y / sumY * 100).toFixed(0)}%`
+            };
+        }
+        return dataPoint;
+    });
+    return {
+        ...series,
+        data: dataPointsWithLabels
+    };
+}
+function _handleDataLabels(series, maxLabels, pieChartSize) {
+    if (series.data.some((dataPoint)=>dataPoint.showLabel)) {
+        // Create data labels where showLabel is true
+        return _createDataLabels(series, pieChartSize, maxLabels, true);
+    } else {
+        // Else treat undefined showLabel as true and create corresponding data labels
+        return _createDataLabels(series, pieChartSize, maxLabels, undefined);
+    }
+}
+/* Internal function to pre-process required metadata for rendering Pie chart */ export function _preProcessPieChartParameters(parameters, hasHeader, hasDescription, hasFooter, cardSize) {
+    const position = _getDataVisualizationComponentPosition(hasHeader, hasDescription, hasFooter);
+    const isPartialHeightCard = position === 'body' && (hasHeader || hasDescription || hasFooter);
+    const pieProperties = _getPieChartProperties(cardSize, position, isPartialHeightCard);
+    const updatedSeries = parameters.series.map((series)=>{
+        // Sort series by descending order of y value
+        const sortedSeries = {
+            ...series,
+            data: [
+                ...series.data
+            ].sort((a, b)=>b.y - a.y).map((item)=>({
+                    ...item
+                }))
+        };
+        // Limit series by number of categories if exceeding maxCategories. Display excess as Others.
+        const limitedSeries = _limitPieDataByMaxCategories(sortedSeries, pieProperties.maxCategories);
+        // Handle data labels based on the showLabel property.
+        return _handleDataLabels(limitedSeries, pieProperties.maxLabels, pieProperties.pieChartSize);
+    });
+    return {
+        ...parameters,
+        series: [
+            updatedSeries[0]
+        ],
+        _metadata: {
+            position: _getDataVisualizationComponentPosition(hasHeader, hasDescription, hasFooter),
+            pieChartSize: pieProperties.pieChartSize
+        }
+    };
+}
+
+//# sourceMappingURL=./PieChartComponent.js.map

package/lib-esm/components/PoweredByComponent.js

@@ -0,0 +1,10 @@
+/**
+ * @internal
+ */ export function _cardViewPoweredByConfigurationToParameters(configuration) {
+    return {
+        ...configuration,
+        componentName: 'poweredBy'
+    };
+}
+
+//# sourceMappingURL=./PoweredByComponent.js.map

package/lib-esm/components/PromptsSetComponent.js

@@ -0,0 +1,10 @@
+/**
+ * @internal
+ */ export function _promptsSetConfigurationToParameters(configuration) {
+    return {
+        ...configuration,
+        componentName: 'promptsSet'
+    };
+}
+
+//# sourceMappingURL=./PromptsSetComponent.js.map

package/lib-esm/components/SearchBoxComponent.js

@@ -0,0 +1,10 @@
+/**
+ * @internal
+ */ export function _searchBoxConfigurationToParameters(configuration) {
+    return {
+        ...configuration,
+        componentName: 'searchBox'
+    };
+}
+
+//# sourceMappingURL=./SearchBoxComponent.js.map

package/lib-esm/components/SearchFooterComponent.js

@@ -0,0 +1,8 @@
+export function _searchFooterConfigurationToParameters(configuration) {
+    return {
+        ...configuration,
+        componentName: 'searchFooter'
+    };
+}
+
+//# sourceMappingURL=./SearchFooterComponent.js.map

package/lib-esm/components/TextComponent.js

@@ -0,0 +1,10 @@
+/**
+ * @internal
+ */ export function _textConfigurationToParameters(configuration) {
+    return {
+        ...configuration,
+        componentName: 'text'
+    };
+}
+
+//# sourceMappingURL=./TextComponent.js.map

package/lib-esm/components/TextInputComponent.js

@@ -0,0 +1,10 @@
+/**
+ * @internal
+ */ export function _textInputConfigurationToParameters(configuration) {
+    return {
+        ...configuration,
+        componentName: 'textInput'
+    };
+}
+
+//# sourceMappingURL=./TextInputComponent.js.map

package/{lib → lib-esm}/index.js

@@ -6,8 +6,7 @@
  * Adaptive Cards to deliver rich, native experiences.
  *
  * @packagedocumentation
- */
-export { AdaptiveCardExtensionActionShim as _AdaptiveCardExtensionActionShim } from './actionShim/AdaptiveCardExtensionActionShim';
+ */ export { AdaptiveCardExtensionActionShim as _AdaptiveCardExtensionActionShim } from './actionShim/AdaptiveCardExtensionActionShim';
 export { getOnBeforeActionArguments as _getOnBeforeActionArguments } from './actionShim/getOnBeforeActionArguments';
 export { AdaptiveCardExtensionContext } from './AdaptiveCardExtensionContext';
 export { AdaptiveCardExtensionHost as _AdaptiveCardExtensionHost } from './AdaptiveCardExtensionHost';
@@ -41,4 +40,5 @@ export { BaseComponentsCardView } from './views/card/BaseComponentsCardView';
 export { getRenderArgumentsForMessaging as _getRenderArgumentsForMessaging, prepareRenderArgumentsForMessaging as _prepareRenderArgumentsForMessaging } from './isolation/RenderArgumentsUtils';
 export { PRIMARY_TEXT as _PRIMARY_TEXT, BODY_SECONDARY_TEXT as _BODY_SECONDARY_TEXT, BODY_PRIMARY_TEXT as _BODY_PRIMARY_TEXT, TITLE_TEXT as _TITLE_TEXT } from './ac-template/common/CustomElements';
 export { CardViewParametersProcessors as _CardViewParametersProcessors } from './views/card/parameters/CardViewParametersProcessors';
-//# sourceMappingURL=index.js.map
+
+//# sourceMappingURL=./index.js.map

package/lib-esm/interfaces/CardActionType.js

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

package/lib-esm/interfaces/IActionArguments.js

@@ -0,0 +1,7 @@
+/**
+ * Base object passed to {@link IAdaptiveCardExtensionActionView.onActionError} when an Adaptive Card OnActionError is executed.
+ *
+ *  @public
+ */ export { };
+
+//# sourceMappingURL=./IActionArguments.js.map

package/lib-esm/interfaces/IAdaptiveCardExtension.js

@@ -0,0 +1,7 @@
+/**
+ * `IAdaptiveCardExtension` is equivalent to public APIs of `BaseAdaptiveCardExtension`.
+ *
+ * @internal
+ */ export { };
+
+//# sourceMappingURL=./IAdaptiveCardExtension.js.map

package/lib-esm/interfaces/IAdaptiveCardExtensionData.js

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

package/lib-esm/interfaces/IAdaptiveCardExtensionImage.js

@@ -0,0 +1,15 @@
+/**
+ * Properties for the image rendered in a card view.
+ *
+ * @remarks The image can be displayed as part of the card view itself as well as in buttons.
+ *
+ * @public
+ */ /**
+ * Card view icon.
+ *
+ * @remarks The icon can be displayed as part of the card bar as well as in buttons.
+ *
+ * @public
+ */ export { };
+
+//# sourceMappingURL=./IAdaptiveCardExtensionImage.js.map

package/lib-esm/interfaces/IAdaptiveCardExtensionLoadContext.js

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

package/lib-esm/interfaces/IAdaptiveCardExtensionPropertiesMetadata.js

@@ -0,0 +1,7 @@
+/**
+ * This is the structure used for map values in `IAdaptiveCardExtensionPropertiesMetadata`.
+ *
+ * @public
+ */ export { };
+
+//# sourceMappingURL=./IAdaptiveCardExtensionPropertiesMetadata.js.map

package/lib-esm/interfaces/IAdaptiveCardRenderParameters.js

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

package/lib-esm/interfaces/IBaseCardParameters.js

@@ -0,0 +1,11 @@
+/**
+ * Size of the Card view.
+ *
+ * @public
+ */ /**
+ * The data parameters for Sign In Card View for Bot ACEs in Teams.
+ *
+ * @internal
+ */ export { };
+
+//# sourceMappingURL=./IBaseCardParameters.js.map

package/lib-esm/interfaces/ICardButton.js

@@ -0,0 +1,6 @@
+/**
+ * Confirmation Dialog option that is passed through `Submit` Action is executed.
+ * @public
+ */ export { };
+
+//# sourceMappingURL=./ICardButton.js.map

package/lib-esm/interfaces/ICardRenderParameters.js

@@ -0,0 +1,6 @@
+/**
+ * `Card` is the default render View. `QuickView` is a more detailed view of the Adaptive Card Extension.
+ * @public
+ */ export { };
+
+//# sourceMappingURL=./ICardRenderParameters.js.map

package/{lib → lib-esm}/interfaces/IFocusParameters.js

@@ -4,6 +4,6 @@
  * @remarks `focusTarget` is ignored for the initial opening of the quick view. Any subsequent quick view changes will utilize `focusTarget`.
  *
  * @public
- */
-export {};
-//# sourceMappingURL=IFocusParameters.js.map
+ */ export { };
+
+//# sourceMappingURL=./IFocusParameters.js.map

package/lib-esm/interfaces/IGetLocationActionTypes.js

@@ -0,0 +1,7 @@
+/**
+ * This object represents the error data that the Location action can throw.
+
+ * @public
+ */ export { };
+
+//# sourceMappingURL=./IGetLocationActionTypes.js.map

package/lib-esm/interfaces/IHostContext.js

@@ -0,0 +1,15 @@
+/**
+ *
+ * HostTheme is used to define the current colour scheme for the Client (VCM) app. It can be
+ * - `light`: Client app is in light mode,
+ * - `dark`: Client app is in dark mode,
+ * - `undefined`: Unspecified Environment. (For web and Teams app desktop we get the value undefined).
+ * @internal @deprecated - Use `sdks` to access teams Context instead.
+ */ /**
+ * IHostContext is an object which is passed to Adaptive card context to access different options of Client Environment.
+ * Ex: theme of Viva Connections Mobile (VCM) App (light/dark)'
+ *
+ * @internal @deprecated - Use `sdks` to access teams Context instead.
+ */ export { };
+
+//# sourceMappingURL=./IHostContext.js.map

package/lib-esm/interfaces/ILocation.js

@@ -0,0 +1,6 @@
+/**
+ * Interface for location coordinates
+ * @public
+ */ export { };
+
+//# sourceMappingURL=./ILocation.js.map

package/lib-esm/interfaces/INotificationTypes.js

@@ -0,0 +1,9 @@
+/**
+ * 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 { };
+
+//# sourceMappingURL=./INotificationTypes.js.map

package/lib-esm/interfaces/IOnBeforeActionArguments.js

@@ -0,0 +1,7 @@
+/**
+ * The object passed to {@link BaseAdaptiveCardExtension.onBeforeAction} when a `ShowLocation` Action is triggered.
+ *
+ * @public
+ */ export { };
+
+//# sourceMappingURL=./IOnBeforeActionArguments.js.map

package/lib-esm/interfaces/IQuickViewRenderParameters.js

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

package/lib-esm/interfaces/ISPFxAdaptiveCard.js

@@ -0,0 +1,7 @@
+/**
+ * SPFx Adaptive Card Extension schema for Adaptive Cards.
+ *
+ * @public
+ */ export { };
+
+//# sourceMappingURL=./ISPFxAdaptiveCard.js.map

package/{lib → lib-esm}/interfaces/ISelectMediaActionTypes.js

@@ -1,12 +1,8 @@
-/**
- * Enum value to specify the type of media.
-
- * @public
- */
 export var MediaType;
-(function (MediaType) {
+(function(MediaType) {
     MediaType[MediaType["Image"] = 1] = "Image";
     MediaType[MediaType["Audio"] = 4] = "Audio";
     MediaType[MediaType["Document"] = 8] = "Document";
 })(MediaType || (MediaType = {}));
-//# sourceMappingURL=ISelectMediaActionTypes.js.map
+
+//# sourceMappingURL=./ISelectMediaActionTypes.js.map

package/lib-esm/interfaces/ISelectionActionTemplateAdaptiveCard.js

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

package/lib-esm/interfaces/IShowLocationActionTypes.js

@@ -0,0 +1,9 @@
+/**
+ * Error interface for 'VivaAction.ShowLocation' is {@link IGetLocationAction.ILocationErrorArguments}
+ */ /**
+ * Invoke an `VivaAction.ShowLocation` event.
+
+ * @public
+ */ export { };
+
+//# sourceMappingURL=./IShowLocationActionTypes.js.map

package/lib-esm/interfaces/InternalTypes.js

@@ -0,0 +1,6 @@
+/**
+ * @internal
+ * Defines the subType property for the extended TextBlock element.
+ */ export { };
+
+//# sourceMappingURL=./InternalTypes.js.map