@microsoft/teams-js 2.30.0 → 2.31.0-beta.0

package/dist/esm/packages/teams-js/dts/internal/internalAPIs.d.ts

@@ -0,0 +1,61 @@
+import { IBaseRuntime, Runtime } from '../public/runtime';
+/**
+ * Ensures `initialize` was called. This function does NOT verify that a response from Host was received and initialization completed.
+ *
+ * `ensureInitializeCalled` should only be used for APIs which:
+ * - work in all FrameContexts
+ * - are part of a required Capability
+ * - are suspected to be used directly after calling `initialize`, potentially without awaiting the `initialize` call itself
+ *
+ * For most APIs {@link ensureInitialized} is the right validation function to use instead.
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function ensureInitializeCalled(): void;
+/**
+ * Ensures `initialize` was called and response from Host was received and processed and that `runtime` is initialized.
+ * If expected FrameContexts are provided, it also validates that the current FrameContext matches one of the expected ones.
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function ensureInitialized(runtime: IBaseRuntime, ...expectedFrameContexts: string[]): runtime is Runtime;
+/**
+ * @hidden
+ * Checks whether the platform has knowledge of this API by doing a comparison
+ * on API required version and platform supported version of the SDK
+ *
+ * @param requiredVersion - SDK version required by the API
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function isCurrentSDKVersionAtLeast(requiredVersion?: string): boolean;
+/**
+ * @hidden
+ * Helper function to identify if host client is either android, ios, or ipados
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function isHostClientMobile(): boolean;
+/**
+ * @hidden
+ * Helper function which indicates if current API is supported on mobile or not.
+ * @throws SdkError if host client is not android/ios or if the requiredVersion is not
+ *          supported by platform or not. Null is returned in case of success.
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function throwExceptionIfMobileApiIsNotSupported(requiredVersion?: string): void;
+/**
+ * @hidden
+ * Processes the valid origins specifuied by the user, de-duplicates and converts them into a regexp
+ * which is used later for message source/origin validation
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function processAdditionalValidOrigins(validMessageOrigins: string[]): void;

package/dist/esm/packages/teams-js/dts/internal/marketplaceUtils.d.ts

@@ -0,0 +1,94 @@
+import { marketplace } from '../public/marketplace';
+/**
+ * @hidden
+ * deserialize the cart data:
+ * - convert url properties from string to URL
+ * @param cartItems The cart items
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function deserializeCart(cartData: any): marketplace.Cart;
+/**
+ * @hidden
+ * deserialize the cart items:
+ * - convert url properties from string to URL
+ * @param cartItems The cart items
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function deserializeCartItems(cartItemsData: any): marketplace.CartItem;
+/**
+ * @hidden
+ * serialize the cart items:
+ * - make URL properties to string
+ * @param cartItems The cart items
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare const serializeCartItems: (cartItems: marketplace.CartItem[]) => any;
+/**
+ * @hidden
+ * Validate the cart item properties are valid
+ * @param cartItems The cart items
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function validateCartItems(cartItems: marketplace.CartItem[]): void;
+/**
+ * @hidden
+ * Validate accessories
+ * @param accessoryItems The accessories to be validated
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function validateAccessoryItems(accessoryItems: marketplace.Item[] | undefined | null): void;
+/**
+ * @hidden
+ * Validate the basic cart item properties are valid
+ * @param basicCartItem The basic cart item
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function validateBasicCartItem(basicCartItem: marketplace.Item): void;
+/**
+ * @hidden
+ * Validate the id is valid
+ * @param id A uuid string
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function validateUuid(id: string | undefined | null): void;
+/**
+ * @hidden
+ * Validate the cart item properties are valid
+ * @param price The price to be validated
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function validatePrice(price: number): void;
+/**
+ * @hidden
+ * Validate quantity
+ * @param quantity The quantity to be validated
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function validateQuantity(quantity: number): void;
+/**
+ * @hidden
+ * Validate cart status
+ * @param cartStatus The cartStatus to be validated
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function validateCartStatus(cartStatus: marketplace.CartStatus): void;

package/dist/esm/packages/teams-js/dts/internal/mediaUtil.d.ts

@@ -0,0 +1,95 @@
+import { media } from '../public/media';
+import { people } from '../public/people';
+/**
+ * @hidden
+ * Helper function to create a blob from media chunks based on their sequence
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function createFile(assembleAttachment: media.AssembleAttachment[], mimeType: string): Blob | null;
+/**
+ * @hidden
+ * Helper function to convert Media chunks into another object type which can be later assemebled
+ * Converts base 64 encoded string to byte array and then into an array of blobs
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function decodeAttachment(attachment: media.MediaChunk, mimeType: string): media.AssembleAttachment | null;
+/**
+ * @hidden
+ * Function throws an SdkError if the media call is not supported on current mobile version, else undefined.
+ *
+ * @throws an SdkError if the media call is not supported
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function throwExceptionIfMediaCallIsNotSupportedOnMobile(mediaInputs: media.MediaInputs): void;
+/**
+ * @hidden
+ * Function returns true if the app has registered to listen to video controller events, else false.
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function isVideoControllerRegistered(mediaInputs: media.MediaInputs): boolean;
+/**
+ * @hidden
+ * Returns true if the mediaInput params are valid and false otherwise
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function validateSelectMediaInputs(mediaInputs: media.MediaInputs): boolean;
+/**
+ * @hidden
+ * Returns true if the mediaInput params are called for mediatype Image and contains Image outputs formats, false otherwise
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function isMediaCallForImageOutputFormats(mediaInputs: media.MediaInputs): boolean;
+/**
+ * @hidden
+ * Returns true if the mediaInput params are called for mediatype VideoAndImage and false otherwise
+ *
+ * @internal
+ */
+export declare function isMediaCallForVideoAndImageInputs(mediaInputs: media.MediaInputs): boolean;
+/**
+ * @hidden
+ * Returns true if the mediaInput params are called for non-full screen video mode and false otherwise
+ *
+ * @internal
+ */
+export declare function isMediaCallForNonFullScreenVideoMode(mediaInputs: media.MediaInputs): boolean;
+/**
+ * @hidden
+ * Returns true if the get Media params are valid and false otherwise
+ *
+ * @internal
+ */
+export declare function validateGetMediaInputs(mimeType: string, format: media.FileFormat, content: string): boolean;
+/**
+ * @hidden
+ * Returns true if the view images param is valid and false otherwise
+ *
+ * @internal
+ */
+export declare function validateViewImagesInput(uriList: media.ImageUri[]): boolean;
+/**
+ * @hidden
+ * Returns true if the scan barcode param is valid and false otherwise
+ *
+ * @internal
+ */
+export declare function validateScanBarCodeInput(barCodeConfig?: media.BarCodeConfig): boolean;
+/**
+ * @hidden
+ * Returns true if the people picker params are valid and false otherwise
+ *
+ * @internal
+ */
+export declare function validatePeoplePickerInput(peoplePickerInputs?: people.PeoplePickerInputs): boolean;

package/dist/esm/packages/teams-js/dts/internal/messageObjects.d.ts

@@ -0,0 +1,73 @@
+import { UUID as MessageUUID } from './uuidObject';
+/**
+ * @internal
+ * Limited to Microsoft-internal use
+ *
+ * MessageIDs represent the legacy number id used for processing MessageRequests and MessageResponses
+ */
+export type MessageID = number;
+/**
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export interface MessageRequest {
+    id?: MessageID;
+    uuid?: MessageUUID;
+    func: string;
+    timestamp?: number;
+    args?: any[];
+    apiVersionTag?: string;
+    isPartialResponse?: boolean;
+}
+/**
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export interface SerializedMessageRequest {
+    id?: MessageID;
+    uuidAsString?: string;
+    func: string;
+    timestamp?: number;
+    args?: any[];
+    apiVersionTag?: string;
+}
+/**
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export interface SerializedMessageResponse {
+    id: MessageID;
+    uuidAsString?: string;
+    args?: any[];
+    isPartialResponse?: boolean;
+}
+/**
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export interface MessageResponse {
+    id: MessageID;
+    uuid?: MessageUUID;
+    args?: any[];
+    isPartialResponse?: boolean;
+}
+/**
+ * @internal
+ * Limited to Microsoft-internal use
+ *
+ * For reasons that are unclear at this time, some MessageRequest objects can exist without an id or timestamp, even though
+ * many parts of code assume that they are defined.
+ * To enable type-safety in some scenarios, this new interface can be used where these properties are required. Because it
+ * derives from the original interface, objects of this type can be user interchangeably with the original interface.
+ * As the required messaging scenarios are better understood, the interfaces will eventually be updated and
+ * merged. However, it's a journey.
+ */
+export interface MessageRequestWithRequiredProperties extends MessageRequest {
+    id: MessageID;
+    uuid: MessageUUID;
+    timestamp: number;
+}
+export declare const serializeMessageRequest: (message: MessageRequest) => SerializedMessageRequest;
+export declare const deserializeMessageRequest: (message: SerializedMessageRequest) => MessageRequest;
+export declare const deserializeMessageResponse: (serializedResponse: SerializedMessageResponse) => MessageResponse;
+export declare const serializeMessageResponse: (response: MessageResponse) => SerializedMessageResponse;

package/dist/esm/packages/teams-js/dts/internal/nestedAppAuthUtils.d.ts

@@ -0,0 +1,105 @@
+import { MessageRequestWithRequiredProperties } from './messageObjects';
+/**
+ * @hidden
+ * Enumeration for nested app authentication message event names.
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ *
+ * @enum {string}
+ *
+ * @property {string} Request - Event name for a nested app authentication request.
+ * @property {string} Response - Event name for a nested app authentication response.
+ */
+export declare const enum NestedAppAuthMessageEventNames {
+    Request = "NestedAppAuthRequest",
+    Response = "NestedAppAuthResponse"
+}
+/**
+ * @hidden
+ * Interface for a nested app authentication request.
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ *
+ * @interface
+ * @extends {MessageRequest}
+ *
+ * @property {string} func - The function name, should always be 'nestedAppAuthRequest'.
+ * @property {string} data - data associated with the request, represented as a string.
+ */
+export interface NestedAppAuthRequest extends MessageRequestWithRequiredProperties {
+    func: 'nestedAppAuth.execute';
+    data: string;
+}
+/**
+ * @hidden
+ * Interface for parsed data from a nested app authentication message.
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ *
+ * @interface
+ * @property {NestedAppAuthMessageEventNames} messageType - The type of the nested app authentication message event.
+ */
+export interface ParsedNestedAppAuthMessageData {
+    messageType: NestedAppAuthMessageEventNames;
+}
+/**
+ * @hidden
+ * Interface for a nested app authentication bridge.
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ *
+ * @interface
+ *
+ * @property {Function} addEventListener - Function to add an event listener to the bridge. Takes an event name and a callback function as parameters.
+ * @property {Function} postMessage - Function to post a message to the bridge. Takes a message string as a parameter.
+ * @property {Function} removeEventListener - Function to remove an event listener from the bridge. Takes an event name and a callback function as parameters.
+ */
+export interface NestedAppAuthBridge {
+    addEventListener: (eventName: string, callback: (response: string) => void) => void;
+    postMessage: (message: string) => void;
+    removeEventListener: (eventName: string, callback: (response: string) => void) => void;
+}
+/**
+ * @hidden
+ * Interface for a Window object extended with a nested app authentication bridge.
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ *
+ * @interface
+ * @extends {Window}
+ *
+ * @property {NestedAppAuthBridge} nestedAppAuthBridge - The nested app authentication bridge associated with the window.
+ */
+export interface NestedAuthExtendedWindow extends Window {
+    nestedAppAuthBridge: NestedAppAuthBridge;
+}
+/**
+ * @hidden
+ * Type for handlers in a nested app authentication bridge.
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ *
+ * @typedef {Object} NestedAppAuthBridgeHandlers
+ *
+ * @property {Function} onMessage - Function to handle a message event. Takes a MessageEvent object and a callback function as parameters. The callback function is called when a message is received.
+ * @property {Function} handlePostMessage - Function to handle posting a message. Takes a message string as a parameter.
+ */
+type NestedAppAuthBridgeHandlers = {
+    onMessage: (evt: MessageEvent, onMessageReceived: (response: string) => void) => void;
+    sendPostMessage: (message: string) => void;
+};
+/**
+ * @hidden
+ * Attempt to polyfill the nestedAppAuthBridge object on the given window
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function tryPolyfillWithNestedAppAuthBridge(clientSupportedSDKVersion: string, window: Window | null, handlers: NestedAppAuthBridgeHandlers): void;
+export {};

package/dist/esm/packages/teams-js/dts/internal/profileUtil.d.ts

@@ -0,0 +1,11 @@
+import { profile } from '../public/profile';
+/**
+ * @hidden
+ * Validates the request parameters
+ * @param showProfileRequest The request parameters
+ * @returns true if the parameters are valid, false otherwise
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function validateShowProfileRequest(showProfileRequest: profile.ShowProfileRequest): [boolean, string | undefined];

package/dist/esm/packages/teams-js/dts/internal/responseHandler.d.ts

@@ -0,0 +1,30 @@
+/**
+ * This class is used for validating and deserializing the response from the host.
+ *
+ * @typeParam SerializedReturnValueFromHost The type of the response received from the host
+ * @typeParam DeserializedReturnValueFromHost The type of the response after deserialization
+ */
+export declare abstract class ResponseHandler<SerializedReturnValueFromHost, DeserializedReturnValueFromHost> {
+    /**
+     * Checks if the response from the host is valid.
+     *
+     * @param response The response from the host to validate
+     *
+     * @returns True if the response is valid, false otherwise
+     */
+    abstract validate(response: SerializedReturnValueFromHost): boolean;
+    /**
+     * This function converts the response from the host into a different format
+     * before returning it to the caller (if needed).
+     * @param response
+     */
+    abstract deserialize(response: SerializedReturnValueFromHost): DeserializedReturnValueFromHost;
+}
+export type SimpleType = string | number | boolean | null | undefined | SimpleType[];
+/**
+ * This class is used for validating and deserializing boolean responses from the host.
+ */
+export declare class SimpleTypeResponseHandler<T extends SimpleType> extends ResponseHandler<T, T> {
+    validate(_response: T): boolean;
+    deserialize(response: T): T;
+}