@microsoft/teams-js 2.17.0-beta.1 → 2.17.0-beta.2

package/dist/MicrosoftTeams.d.ts

@@ -2819,6 +2819,20 @@ export const minAdaptiveCardVersion: AdaptiveCardVersion;
     * Adaptive Card version supported by the Teams v1 client.
     */
 export const teamsMinAdaptiveCardVersion: HostVersionsInfo;
+/**
+    * @hidden
+    * An error object indicates that the image count from visualMedia.image API is invalid.
+    *
+    * @beta
+    */
+export const errorInvalidCount: Error;
+/**
+    * @hidden
+    * An error object indicates that the response from the visualMedia.image API is invalid.
+    *
+    * @beta
+    */
+export const errorInvalidResponse: Error;
 
 /**
     * Represents information about tabs for an app
@@ -7796,6 +7810,199 @@ export namespace stageView {
   */
 export const version = "ERROR: This value should be replaced by webpack!";
 
+/**
+    * @hidden
+    * Interact with images. Allows the app developer ask the user to get images from their camera / camera roll / file system.
+    *
+    * @beta
+    */
+export namespace visualMedia {
+        /**
+            * @hidden
+            * All properties common to Image and Video Props
+            *
+            * @beta
+            */
+        interface VisualMediaProps {
+                /**
+                    * @hidden
+                    * The maximum number of media items that can be selected at once is limited to values that are less than or equal to the maximum visual media selection limit.
+                    */
+                maxVisualMediaCount: number;
+        }
+        /**
+            * @hidden
+            * The required value of the visualMedia files from gallery
+            *
+            * @beta
+            */
+        export interface GalleryProps {
+                /**
+                    * The visualMedia source
+                    */
+                source: Source.Gallery;
+        }
+        /**
+            * @hidden
+            * The required value of the visualMedia files from camera
+            *
+            * @beta
+            */
+        export interface CameraProps {
+                /**
+                    * @hidden
+                    * The visualMedia source
+                    */
+                source: Source.Camera;
+                /**
+                    * @hidden
+                    * Optional; Specify whether users have the option to switch between the front and rear cameras. The default setting is FrontOrRear.
+                    * Default value is FrontOrRear
+                    */
+                cameraRestriction?: CameraRestriction;
+        }
+        /**
+            * @hidden
+            * Indicate if user is allowed to move between front and back camera or stay in front/back camera only
+            * If the camera option requested by the app isn't available, the SDK will silently default to the platform's standard camera.
+            *
+            * @beta
+            */
+        export enum CameraRestriction {
+                /** User can move between front and back camera */
+                FrontOrRear = 1,
+                /** User can only use the front camera */
+                FrontOnly = 2,
+                /** User can only use the back camera */
+                RearOnly = 3
+        }
+        /**
+            * @hidden
+            * Specifies the image source
+            *
+            * @beta
+            */
+        export enum Source {
+                /** The camera is the source of visual media. */
+                Camera = 1,
+                /** The source of visual media is the gallery. */
+                Gallery = 2
+        }
+        /**
+            * @hidden
+            * VisualMediaFile object that can be used to represent image or video from host apps.
+            *
+            * @beta
+            */
+        export interface VisualMediaFile {
+                /**
+                    * @hidden
+                    * This is the base64 content of file.
+                    * If app needs to use this directly in HTML tags, it should convert this to a data url.
+                    */
+                content: string;
+                /**
+                    * @hidden
+                    * The size of file represented in VisualMediaFile in KB
+                    */
+                sizeInKB: number;
+                /**
+                    * @hidden
+                    * Name of the file (does not include the extension)
+                    */
+                name: string;
+                /**
+                    * @hidden
+                    * File's MIME type. More information on supported `mimeTypes`(https://docs.lens.xyz/docs/metadata-standards#supported-mime-types-for-imagesaudiovideos).
+                    */
+                mimeType: string;
+        }
+        /**
+            * @hidden
+            * Checks whether or not visualMedia has user permission
+            * @returns Promise that will resolve with true if the user had granted the app permission to media information(including Camera and Gallery permission), or with false otherwise,
+            * In case of an error, promise will reject with the error.
+            * @throws NOT_SUPPORTED_ON_PLATFORM Error if the DevicePermission.Media permission has not successfully granted.
+            *
+            * @beta
+            */
+        export function hasPermission(): Promise<boolean>;
+        /**
+            * @hidden
+            * Requests user permission for visualMedia
+            * @returns Promise that will resolve with true if the user consented permission for media(including Camera and Gallery permission), or with false otherwise,
+            * In case of an error, promise will reject with the error.
+            * @throws NOT_SUPPORTED_ON_PLATFORM Error if the DevicePermission.Media permission has not successfully granted.
+            *
+            * @beta
+            */
+        export function requestPermission(): Promise<boolean>;
+        /**
+            * @hidden
+            * To enable this image capability will let the app developer ask the user to get images from camera/local storage
+            *
+            * @beta
+            */
+        export namespace image {
+                /**
+                    * @hidden
+                    * CameraImageProperties is for the image taken from the camera
+                    *
+                    * @beta
+                    */
+                interface CameraImageProperties extends VisualMediaProps {
+                        /**
+                            * @hidden
+                            * The source in CameraImageProperties should always be CameraProps
+                            */
+                        sourceProps: CameraProps;
+                }
+                /**
+                    * @hidden
+                    * CameraImageProperties is for the image taken from the camera
+                    *
+                    * @beta
+                    */
+                interface GalleryImageProperties extends VisualMediaProps {
+                        /**
+                            * @hidden
+                            * The source in GalleryImageProperties should always be GalleryProps
+                            */
+                        sourceProps: GalleryProps;
+                }
+                /**
+                    * @hidden
+                    * Capture one or multiple image(s) using camera.
+                    * @param cameraImageInputs - The input params to customize the image(s) to be captured
+                    * @returns Promise that will resolve with {@link VisualMediaFile[]} object or reject with an error.
+                    * @throws INVALID_ARGUMENTS Error if imageInputs is null or imageInputs.maxVisualMediaCount is greater than maxVisualMediaSelectionLimit or lesser than 1.
+                    *
+                    * @beta
+                    */
+                function captureImages(cameraImageInputs: CameraImageProperties): Promise<VisualMediaFile[]>;
+                /**
+                    * @hidden
+                    * Upload the existing image(s) from the gallery.
+                    * @param galleryImageInputs - The input params to customize the image(s) to be captured
+                    * @returns Promise that will resolve with {@link VisualMediaFile[]} object or reject with an error.
+                    * @throws INVALID_ARGUMENTS Error if imageInputs is null or imageInputs.maxVisualMediaCount is greater than maxVisualMediaSelectionLimit or lesser than 1.
+                    *
+                    * @beta
+                    */
+                function retrieveImages(galleryImageInputs: GalleryImageProperties): Promise<VisualMediaFile[]>;
+                /**
+                    * @hidden
+                    * Checks if visualMedia.image capability is supported by the host
+                    * @returns boolean to represent whether visualMedia.image is supported
+                    * @throws Error if {@linkcode app.initialize} has not successfully completed
+                    *
+                    * @beta
+                    */
+                function isSupported(): boolean;
+        }
+        export {};
+}
+
 /**
     * Contains functionality to allow web apps to store data in webview cache
     *

package/dist/MicrosoftTeams.js

@@ -891,6 +891,7 @@ __webpack_require__.d(__webpack_exports__, {
   version: () => (/* reexport */ version),
   videoEffects: () => (/* reexport */ videoEffects),
   videoEffectsEx: () => (/* reexport */ videoEffectsEx),
+  visualMedia: () => (/* reexport */ visualMedia),
   webStorage: () => (/* reexport */ webStorage)
 });
 
@@ -1030,6 +1031,11 @@ var validOrigins = [
     'www.microsoft365.com',
     'bing.com',
     'edgeservices.bing.com',
+    'www.bing.com',
+    'www.staging-bing-int.com',
+    'teams.cloud.microsoft',
+    'outlook.cloud.microsoft',
+    'm365.cloud.microsoft',
 ];
 /**
  * @hidden
@@ -1476,6 +1482,20 @@ var minAdaptiveCardVersion = { majorVersion: 1, minorVersion: 5 };
 var teamsMinAdaptiveCardVersion = {
     adaptiveCardSchemaVersion: { majorVersion: 1, minorVersion: 5 },
 };
+/**
+ * @hidden
+ * An error object indicates that the image count from visualMedia.image API is invalid.
+ *
+ * @beta
+ */
+var errorInvalidCount = new Error('Invalid input count: Must supply a valid image count (limit of 10).');
+/**
+ * @hidden
+ * An error object indicates that the response from the visualMedia.image API is invalid.
+ *
+ * @beta
+ */
+var errorInvalidResponse = new Error('Invalid response: Received more images than the specified max limit in the response.');
 
 ;// CONCATENATED MODULE: ./src/internal/utils.ts
 /* eslint-disable @typescript-eslint/ban-types */
@@ -2249,7 +2269,7 @@ var _minRuntimeConfigToUninitialize = {
  * @hidden
  *  Package version.
  */
-var version = "2.17.0-beta.1";
+var version = "2.17.0-beta.2";
 
 ;// CONCATENATED MODULE: ./src/internal/internalAPIs.ts
 
@@ -9770,6 +9790,247 @@ var stageView;
     stageView.isSupported = isSupported;
 })(stageView || (stageView = {}));
 
+;// CONCATENATED MODULE: ./src/public/visualMedia.ts
+var visualMedia_awaiter = (undefined && undefined.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var visualMedia_generator = (undefined && undefined.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+
+
+
+
+
+/**
+ * @hidden
+ * Interact with images. Allows the app developer ask the user to get images from their camera / camera roll / file system.
+ *
+ * @beta
+ */
+var visualMedia;
+(function (visualMedia) {
+    var maxVisualMediaSelectionLimit = 10;
+    /**
+     * @hidden
+     * Indicate if user is allowed to move between front and back camera or stay in front/back camera only
+     * If the camera option requested by the app isn't available, the SDK will silently default to the platform's standard camera.
+     *
+     * @beta
+     */
+    var CameraRestriction;
+    (function (CameraRestriction) {
+        /** User can move between front and back camera */
+        CameraRestriction[CameraRestriction["FrontOrRear"] = 1] = "FrontOrRear";
+        /** User can only use the front camera */
+        CameraRestriction[CameraRestriction["FrontOnly"] = 2] = "FrontOnly";
+        /** User can only use the back camera */
+        CameraRestriction[CameraRestriction["RearOnly"] = 3] = "RearOnly";
+    })(CameraRestriction = visualMedia.CameraRestriction || (visualMedia.CameraRestriction = {}));
+    /**
+     * @hidden
+     * Specifies the image source
+     *
+     * @beta
+     */
+    var Source;
+    (function (Source) {
+        /** The camera is the source of visual media. */
+        Source[Source["Camera"] = 1] = "Camera";
+        /** The source of visual media is the gallery. */
+        Source[Source["Gallery"] = 2] = "Gallery";
+    })(Source = visualMedia.Source || (visualMedia.Source = {}));
+    /**
+     * @hidden
+     * Checks whether or not visualMedia has user permission
+     * @returns Promise that will resolve with true if the user had granted the app permission to media information(including Camera and Gallery permission), or with false otherwise,
+     * In case of an error, promise will reject with the error.
+     * @throws NOT_SUPPORTED_ON_PLATFORM Error if the DevicePermission.Media permission has not successfully granted.
+     *
+     * @beta
+     */
+    function hasPermission() {
+        ensureInitialized(runtime, FrameContexts.content, FrameContexts.task);
+        if (!image.isSupported()) {
+            throw errorNotSupportedOnPlatform;
+        }
+        var permissions = DevicePermission.Media;
+        return sendAndHandleSdkError('permissions.has', permissions);
+    }
+    visualMedia.hasPermission = hasPermission;
+    /**
+     * @hidden
+     * Requests user permission for visualMedia
+     * @returns Promise that will resolve with true if the user consented permission for media(including Camera and Gallery permission), or with false otherwise,
+     * In case of an error, promise will reject with the error.
+     * @throws NOT_SUPPORTED_ON_PLATFORM Error if the DevicePermission.Media permission has not successfully granted.
+     *
+     * @beta
+     */
+    function requestPermission() {
+        ensureInitialized(runtime, FrameContexts.content, FrameContexts.task);
+        if (!image.isSupported()) {
+            throw errorNotSupportedOnPlatform;
+        }
+        var permissions = DevicePermission.Media;
+        return sendAndHandleSdkError('permissions.request', permissions);
+    }
+    visualMedia.requestPermission = requestPermission;
+    /**
+     * @hidden
+     * To enable this image capability will let the app developer ask the user to get images from camera/local storage
+     *
+     * @beta
+     */
+    var image;
+    (function (image) {
+        /**
+         * @hidden
+         * Capture one or multiple image(s) using camera.
+         * @param cameraImageInputs - The input params to customize the image(s) to be captured
+         * @returns Promise that will resolve with {@link VisualMediaFile[]} object or reject with an error.
+         * @throws INVALID_ARGUMENTS Error if imageInputs is null or imageInputs.maxVisualMediaCount is greater than maxVisualMediaSelectionLimit or lesser than 1.
+         *
+         * @beta
+         */
+        function captureImages(cameraImageInputs) {
+            return visualMedia_awaiter(this, void 0, void 0, function () {
+                var files;
+                return visualMedia_generator(this, function (_a) {
+                    switch (_a.label) {
+                        case 0:
+                            ensureInitialized(runtime, FrameContexts.content, FrameContexts.task);
+                            ensureSupported();
+                            ensureImageInputValid(cameraImageInputs);
+                            return [4 /*yield*/, sendAndHandleSdkError('visualMedia.image.captureImages', cameraImageInputs)];
+                        case 1:
+                            files = _a.sent();
+                            ensureResponseValid(cameraImageInputs.maxVisualMediaCount, files);
+                            return [2 /*return*/, files];
+                    }
+                });
+            });
+        }
+        image.captureImages = captureImages;
+        /**
+         * @hidden
+         * Upload the existing image(s) from the gallery.
+         * @param galleryImageInputs - The input params to customize the image(s) to be captured
+         * @returns Promise that will resolve with {@link VisualMediaFile[]} object or reject with an error.
+         * @throws INVALID_ARGUMENTS Error if imageInputs is null or imageInputs.maxVisualMediaCount is greater than maxVisualMediaSelectionLimit or lesser than 1.
+         *
+         * @beta
+         */
+        function retrieveImages(galleryImageInputs) {
+            return visualMedia_awaiter(this, void 0, void 0, function () {
+                var files;
+                return visualMedia_generator(this, function (_a) {
+                    switch (_a.label) {
+                        case 0:
+                            ensureInitialized(runtime, FrameContexts.content, FrameContexts.task);
+                            ensureSupported();
+                            ensureImageInputValid(galleryImageInputs);
+                            return [4 /*yield*/, sendAndHandleSdkError('visualMedia.image.retrieveImages', galleryImageInputs)];
+                        case 1:
+                            files = _a.sent();
+                            ensureResponseValid(galleryImageInputs.maxVisualMediaCount, files);
+                            return [2 /*return*/, files];
+                    }
+                });
+            });
+        }
+        image.retrieveImages = retrieveImages;
+        /**
+         * @hidden
+         * Checks if visualMedia.image capability is supported by the host
+         * @returns boolean to represent whether visualMedia.image is supported
+         * @throws Error if {@linkcode app.initialize} has not successfully completed
+         *
+         * @beta
+         */
+        function isSupported() {
+            return ensureInitialized(runtime) &&
+                runtime.supports.visualMedia &&
+                runtime.supports.visualMedia.image &&
+                runtime.supports.permissions
+                ? true
+                : false;
+        }
+        image.isSupported = isSupported;
+        /**
+         * @hidden
+         * Ensure visualMedia.image capability is supported by the host
+         * @throws errorNotSupportedOnPlatform error if isSupported() fails.
+         *
+         * @beta
+         */
+        function ensureSupported() {
+            if (!isSupported()) {
+                throw errorNotSupportedOnPlatform;
+            }
+        }
+        /**
+         * @hidden
+         * @param imageInput the input can be either CameraImageProperties or GalleryImageProperties
+         * @param source the expected Source
+         * @throws error if the input check fails.
+         * @beta
+         */
+        function ensureImageInputValid(imageInput) {
+            if (!imageInput ||
+                imageInput.maxVisualMediaCount > maxVisualMediaSelectionLimit ||
+                imageInput.maxVisualMediaCount < 1) {
+                throw errorInvalidCount;
+            }
+        }
+        /**
+         * @hidden
+         * Ensure the number of images in the response is within the maximum limit.
+         * @throws error if length check fails.
+         * @param maxCount the maxVisualMediaCount set in the imageInpus
+         * @param response the response passed from host app
+         *
+         * @beta
+         */
+        function ensureResponseValid(maxCount, response) {
+            // to ensure the number of images in the response is within the maximum limit.
+            if (response.length > maxCount) {
+                throw errorInvalidResponse;
+            }
+        }
+    })(image = visualMedia.image || (visualMedia.image = {}));
+})(visualMedia || (visualMedia = {}));
+
 ;// CONCATENATED MODULE: ./src/public/webStorage.ts
 
 
@@ -11219,6 +11480,7 @@ var marketplace;
 
 
 
+