@microsoft/teams-js 2.33.0 → 3.0.0-beta.1

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

@@ -300,7 +300,10 @@ export declare const enum ApiName {
     Sharing_ShareWebContent = "sharing.shareWebContent",
     StageView_Open = "stageView.open",
     StageView_Self_Close = "stageView.self.close",
-    Store_Open = "store.open",
+    Store_OpenFullStore = "store.openFullStore",
+    Store_OpenAppDetail = "store.openAppDetail",
+    Store_OpenInContextStore = "store.openInContextStore",
+    Store_OpenSpecificStore = "store.openSpecificStore",
     Tasks_StartTask = "tasks.startTask",
     Tasks_SubmitTask = "tasks.submitTask",
     Tasks_UpdateTask = "tasks.updateTask",

package/dist/esm/packages/teams-js/dts/private/store.d.ts

@@ -1,41 +1,57 @@
+import { DialogSize } from '../public';
 import { AppId } from '../public/appId';
 /**
  * @beta
  * @hidden
- * Enum of store dialog type
+ * @module
+ * Namespace to open app store
  * @internal
  * Limited to Microsoft-internal use
  */
-export declare enum StoreDialogType {
-    /**
-     * open a store without navigation
-     */
-    FullStore = "fullstore",
-    /**
-     * open a store with navigation to a specific collection
-     */
-    SpecificStore = "specificstore",
-    /**
-     * open in-context-store
-     */
-    InContextStore = "ics",
+/**
+ * @beta
+ * @hidden
+ * Interface for opening the full store function parameters
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export interface OpenFullStoreParams {
     /**
-     * open detail dialog (DD)
+     * the store dialog size, defined by {@link DialogSize}, if not present, the host will choose an appropriate size
      */
-    AppDetail = "appdetail"
+    size?: DialogSize;
 }
 /**
  * @beta
  * @hidden
- * Interface of open full store, copilot store and in-context-store function parameter
+ * Interface for opening the in-context store function parameters
  * @internal
  * Limited to Microsoft-internal use
  */
-export interface OpenFullStoreAndICSParams {
+export interface OpenInContextStoreParams {
+    /**
+     * the store dialog size, defined by {@link DialogSize}, if not present, the host will choose an appropriate size
+     */
+    size?: DialogSize;
+    /**
+     * The application capability (e.g., "Tab", "Bot", "Messaging", "Connector", "CUSTOMBOT").
+     * Defaults to "Tab".
+     */
+    appCapability?: string;
+    /**
+     * The application meta capabilities (e.g., ["copilotPlugins", "copilotExtensions"]).
+     * Defaults to "[]".
+     */
+    appMetaCapabilities?: string[];
     /**
-     * the store dialog type, defined by {@link StoreDialogType}
+     * The installation scope (e.g., "Personal" | "Team").
+     * Defaults to "Personal".
      */
-    dialogType: StoreDialogType.FullStore | StoreDialogType.InContextStore;
+    installationScope?: string;
+    /**
+     * A list of app IDs to be filtered out.
+     */
+    filteredOutAppIds?: AppId[];
 }
 /**
  * @beta
@@ -45,14 +61,14 @@ export interface OpenFullStoreAndICSParams {
  * Limited to Microsoft-internal use
  */
 export interface OpenAppDetailParams {
-    /**
-     * need to be app detail type, defined by {@link StoreDialogType}
-     */
-    dialogType: StoreDialogType.AppDetail;
     /**
      * app id of the dialog to open
      */
     appId: AppId;
+    /**
+     * the store dialog size, defined by {@link DialogSize}, if not present, the host will choose an appropriate size
+     */
+    size?: DialogSize;
 }
 /**
  * @beta
@@ -62,58 +78,47 @@ export interface OpenAppDetailParams {
  * Limited to Microsoft-internal use
  */
 export interface OpenSpecificStoreParams {
-    /**
-     * need to be specific store type, defined by {@link StoreDialogType}
-     */
-    dialogType: StoreDialogType.SpecificStore;
     /**
      * collection id of the plugin store to open
      */
     collectionId: string;
+    /**
+     * the store dialog size, defined by {@link DialogSize}, if not present, the host will choose an appropriate size
+     */
+    size?: DialogSize;
 }
 /**
  * @beta
  * @hidden
- * Interface of open store function parameters, including OpenFullStoreAndICSParams, OpenAppDetailParams, OpenSpecificStoreParams
+ * Api to open a full store without navigation
  * @internal
  * Limited to Microsoft-internal use
  */
-export type OpenStoreParams = OpenFullStoreAndICSParams | OpenAppDetailParams | OpenSpecificStoreParams;
+export declare function openFullStore(params: OpenFullStoreParams | undefined): Promise<void>;
 /**
  * @beta
  * @hidden
- * error message when getting invalid store dialog type
+ * Api to open an app detail dialog
  * @internal
  * Limited to Microsoft-internal use
  */
-export declare const errorInvalidDialogType = "Invalid store dialog type, but type needed to specify store to open";
+export declare function openAppDetail(params: OpenAppDetailParams): Promise<void>;
 /**
  * @beta
  * @hidden
- * error message when getting wrong app id or missing app id
+ * Api to open an in-context-store dialog
  * @internal
  * Limited to Microsoft-internal use
  */
-export declare const errorMissingAppId = "No App Id present, but AppId needed to open AppDetail store";
+export declare function openInContextStore(params: OpenInContextStoreParams | undefined): Promise<void>;
 /**
  * @beta
  * @hidden
- * error message when getting wrong collection id or missing collection id
- * @internal
- * Limited to Microsoft-internal use
- */
-export declare const errorMissingCollectionId = "No Collection Id present, but CollectionId needed to open a store specific to a collection";
-/**
- * @beta
- * @hidden
- * Api to open a store
- *
- * @param openStoreParams - params to call openStoreExperience
- *
+ * Api to open an store with navigation to a specific collection
  * @internal
  * Limited to Microsoft-internal use
  */
-export declare function openStoreExperience(openStoreParams: OpenStoreParams): Promise<void>;
+export declare function openSpecificStore(params: OpenSpecificStoreParams): Promise<void>;
 /**
  * Checks if the store capability is supported by the host
  * @returns boolean to represent whether the store capability is supported

package/dist/esm/packages/teams-js/src/private/store.js

@@ -1 +1 @@
-import{__awaiter as e}from"../../../../node_modules/.pnpm/@rollup_plugin-typescript@11.1.6_rollup@4.24.4_tslib@2.6.3_typescript@4.9.5/node_modules/tslib/tslib.es6.js";import{callFunctionInHost as o}from"../internal/communication.js";import{ensureInitialized as t}from"../internal/internalAPIs.js";import{getApiVersionTag as i}from"../internal/telemetry.js";import{AppId as r}from"../public/appId.js";import{FrameContexts as p,errorNotSupportedOnPlatform as n}from"../public/constants.js";import{runtime as l}from"../public/runtime.js";var s;!function(e){e.FullStore="fullstore",e.SpecificStore="specificstore",e.InContextStore="ics",e.AppDetail="appdetail"}(s||(s={}));const c="Invalid store dialog type, but type needed to specify store to open",d="No App Id present, but AppId needed to open AppDetail store",a="No Collection Id present, but CollectionId needed to open a store specific to a collection";function u(u){return e(this,void 0,void 0,(function*(){if(t(l,p.content,p.sidePanel,p.meetingStage),!f())throw n;if(void 0===u||!Object.values(s).includes(u.dialogType))throw new Error(c);if(u.dialogType===s.AppDetail&&!(u.appId instanceof r))throw new Error(d);if(u.dialogType===s.SpecificStore&&!u.collectionId)throw new Error(a);return o("store.open",[u.dialogType,u.appId,u.collectionId],i("v2","store.open"))}))}function f(){return t(l)&&!!l.supports.store}export{s as StoreDialogType,c as errorInvalidDialogType,d as errorMissingAppId,a as errorMissingCollectionId,f as isSupported,u as openStoreExperience};
+import{__awaiter as t}from"../../../../node_modules/.pnpm/@rollup_plugin-typescript@11.1.6_rollup@4.24.4_tslib@2.6.3_typescript@4.9.5/node_modules/tslib/tslib.es6.js";import{callFunctionInHost as o}from"../internal/communication.js";import{ensureInitialized as e}from"../internal/internalAPIs.js";import{getApiVersionTag as n}from"../internal/telemetry.js";import{AppId as i}from"../public/appId.js";import{FrameContexts as r,errorNotSupportedOnPlatform as p}from"../public/constants.js";import{runtime as s}from"../public/runtime.js";const l="v2",u="Invalid store dialog size";function c(e){return t(this,void 0,void 0,(function*(){v();const{size:t}=null!=e?e:{};return o("store.openFullStore",[b(t)],n(l,"store.openFullStore"))}))}function d(e){return t(this,void 0,void 0,(function*(){v();const{size:t,appId:r}=e;if(!(r instanceof i))throw new Error("No App Id present, but AppId needed to open AppDetail store");return o("store.openAppDetail",[b(t),r],n(l,"store.openAppDetail"))}))}function f(e){return t(this,void 0,void 0,(function*(){v();const{size:t,appCapability:i,appMetaCapabilities:r,installationScope:p,filteredOutAppIds:s}=null!=e?e:{};return o("store.openInContextStore",[b(t),i,r,p,null==s?void 0:s.map((t=>t.toString()))],n(l,"store.openInContextStore"))}))}function a(e){return t(this,void 0,void 0,(function*(){v();const{size:t,collectionId:i}=e;if(void 0===i)throw new Error("No Collection Id present, but CollectionId needed to open a store specific to a collection");return o("store.openSpecificStore",[b(t),i],n(l,"store.openSpecificStore"))}))}function m(){return e(s)&&!!s.supports.store}function v(){if(e(s,r.content,r.sidePanel,r.meetingStage),!m())throw p}function b(t){if(void 0===t)return;const{width:o,height:e}=t;if(void 0!==o&&"number"==typeof o&&o<0)throw new Error(u);if(void 0!==e&&"number"==typeof e&&e<0)throw new Error(u);return JSON.stringify(t)}export{m as isSupported,d as openAppDetail,c as openFullStore,f as openInContextStore,a as openSpecificStore};

package/dist/esm/packages/teams-js/src/public/version.js

@@ -1 +1 @@
-const o="2.33.0";export{o as version};
+const t="3.0.0-beta.1";export{t as version};

package/dist/umd/MicrosoftTeams.js

@@ -1607,12 +1607,11 @@ __webpack_require__.d(hostEntity_namespaceObject, {
 var store_namespaceObject = {};
 __webpack_require__.r(store_namespaceObject);
 __webpack_require__.d(store_namespaceObject, {
-  StoreDialogType: () => (StoreDialogType),
-  errorInvalidDialogType: () => (errorInvalidDialogType),
-  errorMissingAppId: () => (errorMissingAppId),
-  errorMissingCollectionId: () => (errorMissingCollectionId),
   isSupported: () => (store_isSupported),
-  openStoreExperience: () => (openStoreExperience)
+  openAppDetail: () => (openAppDetail),
+  openFullStore: () => (openFullStore),
+  openInContextStore: () => (openInContextStore),
+  openSpecificStore: () => (openSpecificStore)
 });
 
 // NAMESPACE OBJECT: ./src/public/appInstallDialog.ts
@@ -4461,7 +4460,7 @@ function isSerializable(arg) {
  * @hidden
  *  Package version.
  */
-const version = "2.33.0";
+const version = "3.0.0-beta.1";
 
 ;// ./src/internal/internalAPIs.ts
 
@@ -13023,95 +13022,76 @@ var store_awaiter = (undefined && undefined.__awaiter) || function (thisArg, _ar
 
 
 
-/**
- * @beta
- * @hidden
- * @module
- * Namespace to open app store
- * @internal
- * Limited to Microsoft-internal use
- */
 const StoreVersionTagNum = "v2" /* ApiVersionNumber.V_2 */;
+const errorInvalidDialogSize = 'Invalid store dialog size';
+const errorMissingAppId = 'No App Id present, but AppId needed to open AppDetail store';
+const errorMissingCollectionId = 'No Collection Id present, but CollectionId needed to open a store specific to a collection';
 /**
  * @beta
  * @hidden
- * Enum of store dialog type
- * @internal
- * Limited to Microsoft-internal use
- */
-var StoreDialogType;
-(function (StoreDialogType) {
-    /**
-     * open a store without navigation
-     */
-    StoreDialogType["FullStore"] = "fullstore";
-    /**
-     * open a store with navigation to a specific collection
-     */
-    StoreDialogType["SpecificStore"] = "specificstore";
-    /**
-     * open in-context-store
-     */
-    StoreDialogType["InContextStore"] = "ics";
-    /**
-     * open detail dialog (DD)
-     */
-    StoreDialogType["AppDetail"] = "appdetail";
-})(StoreDialogType || (StoreDialogType = {}));
-/**
- * @beta
- * @hidden
- * error message when getting invalid store dialog type
+ * Api to open a full store without navigation
  * @internal
  * Limited to Microsoft-internal use
  */
-const errorInvalidDialogType = 'Invalid store dialog type, but type needed to specify store to open';
+function openFullStore(params) {
+    return store_awaiter(this, void 0, void 0, function* () {
+        ensureStoreReady();
+        const { size } = params !== null && params !== void 0 ? params : {};
+        return callFunctionInHost("store.openFullStore" /* ApiName.Store_OpenFullStore */, [serializeValidSize(size)], getApiVersionTag(StoreVersionTagNum, "store.openFullStore" /* ApiName.Store_OpenFullStore */));
+    });
+}
 /**
  * @beta
  * @hidden
- * error message when getting wrong app id or missing app id
+ * Api to open an app detail dialog
  * @internal
  * Limited to Microsoft-internal use
  */
-const errorMissingAppId = 'No App Id present, but AppId needed to open AppDetail store';
+function openAppDetail(params) {
+    return store_awaiter(this, void 0, void 0, function* () {
+        ensureStoreReady();
+        const { size, appId } = params;
+        if (!(appId instanceof AppId)) {
+            throw new Error(errorMissingAppId);
+        }
+        return callFunctionInHost("store.openAppDetail" /* ApiName.Store_OpenAppDetail */, [serializeValidSize(size), appId], getApiVersionTag(StoreVersionTagNum, "store.openAppDetail" /* ApiName.Store_OpenAppDetail */));
+    });
+}
 /**
  * @beta
  * @hidden
- * error message when getting wrong collection id or missing collection id
+ * Api to open an in-context-store dialog
  * @internal
  * Limited to Microsoft-internal use
  */
-const errorMissingCollectionId = 'No Collection Id present, but CollectionId needed to open a store specific to a collection';
+function openInContextStore(params) {
+    return store_awaiter(this, void 0, void 0, function* () {
+        ensureStoreReady();
+        const { size, appCapability, appMetaCapabilities, installationScope, filteredOutAppIds } = params !== null && params !== void 0 ? params : {};
+        return callFunctionInHost("store.openInContextStore" /* ApiName.Store_OpenInContextStore */, [
+            serializeValidSize(size),
+            appCapability,
+            appMetaCapabilities,
+            installationScope,
+            filteredOutAppIds === null || filteredOutAppIds === void 0 ? void 0 : filteredOutAppIds.map((id) => id.toString()),
+        ], getApiVersionTag(StoreVersionTagNum, "store.openInContextStore" /* ApiName.Store_OpenInContextStore */));
+    });
+}
 /**
  * @beta
  * @hidden
- * Api to open a store
- *
- * @param openStoreParams - params to call openStoreExperience
- *
+ * Api to open an store with navigation to a specific collection
  * @internal
  * Limited to Microsoft-internal use
  */
-function openStoreExperience(openStoreParams) {
+function openSpecificStore(params) {
     return store_awaiter(this, void 0, void 0, function* () {
-        ensureInitialized(runtime, FrameContexts.content, FrameContexts.sidePanel, FrameContexts.meetingStage);
-        if (!store_isSupported()) {
-            throw errorNotSupportedOnPlatform;
-        }
-        if (openStoreParams === undefined || !Object.values(StoreDialogType).includes(openStoreParams.dialogType)) {
-            throw new Error(errorInvalidDialogType);
-        }
-        if (openStoreParams.dialogType === StoreDialogType.AppDetail && !(openStoreParams.appId instanceof AppId)) {
-            throw new Error(errorMissingAppId);
-        }
-        if (openStoreParams.dialogType === StoreDialogType.SpecificStore && !openStoreParams.collectionId) {
+        ensureStoreReady();
+        const { size, collectionId } = params;
+        if (collectionId === undefined) {
             throw new Error(errorMissingCollectionId);
         }
-        return callFunctionInHost("store.open" /* ApiName.Store_Open */, [
-            openStoreParams.dialogType,
-            openStoreParams.appId,
-            openStoreParams.collectionId,
-        ], getApiVersionTag(StoreVersionTagNum, "store.open" /* ApiName.Store_Open */));
+        return callFunctionInHost("store.openSpecificStore" /* ApiName.Store_OpenSpecificStore */, [serializeValidSize(size), collectionId], getApiVersionTag(StoreVersionTagNum, "store.openSpecificStore" /* ApiName.Store_OpenSpecificStore */));
     });
 }
 /**
@@ -13123,6 +13103,25 @@ function openStoreExperience(openStoreParams) {
 function store_isSupported() {
     return ensureInitialized(runtime) && !!runtime.supports.store;
 }
+function ensureStoreReady() {
+    ensureInitialized(runtime, FrameContexts.content, FrameContexts.sidePanel, FrameContexts.meetingStage);
+    if (!store_isSupported()) {
+        throw errorNotSupportedOnPlatform;
+    }
+}
+function serializeValidSize(size) {
+    if (size === undefined) {
+        return undefined;
+    }
+    const { width, height } = size;
+    if (width !== undefined && typeof width === 'number' && width < 0) {
+        throw new Error(errorInvalidDialogSize);
+    }
+    if (height !== undefined && typeof height === 'number' && height < 0) {
+        throw new Error(errorInvalidDialogSize);
+    }
+    return JSON.stringify(size);
+}
 
 ;// ./src/private/index.ts