@jevelin/bridge 2.53.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +12 -0
- package/README.md +78 -0
- package/dist/esm/_virtual/_polyfill-node.buffer.js +1 -0
- package/dist/esm/_virtual/_polyfill-node.global.js +1 -0
- package/dist/esm/_virtual/browser.js +1 -0
- package/dist/esm/node_modules/.pnpm/@rollup_plugin-typescript@11.1.6_rollup@4.55.1_tslib@2.8.1_typescript@4.9.5/node_modules/tslib/tslib.es6.js +1 -0
- package/dist/esm/node_modules/.pnpm/debug@4.3.5/node_modules/debug/src/browser.js +1 -0
- package/dist/esm/node_modules/.pnpm/debug@4.3.5/node_modules/debug/src/common.js +1 -0
- package/dist/esm/node_modules/.pnpm/ms@2.1.2/node_modules/ms/index.js +1 -0
- package/dist/esm/node_modules/.pnpm/uuid@11.1.1/node_modules/uuid/dist/esm-browser/native.js +1 -0
- package/dist/esm/node_modules/.pnpm/uuid@11.1.1/node_modules/uuid/dist/esm-browser/regex.js +1 -0
- package/dist/esm/node_modules/.pnpm/uuid@11.1.1/node_modules/uuid/dist/esm-browser/rng.js +1 -0
- package/dist/esm/node_modules/.pnpm/uuid@11.1.1/node_modules/uuid/dist/esm-browser/stringify.js +1 -0
- package/dist/esm/node_modules/.pnpm/uuid@11.1.1/node_modules/uuid/dist/esm-browser/v4.js +1 -0
- package/dist/esm/node_modules/.pnpm/uuid@11.1.1/node_modules/uuid/dist/esm-browser/validate.js +1 -0
- package/dist/esm/packages/teams-js/dts/index.d.ts +2 -0
- package/dist/esm/packages/teams-js/dts/internal/VideoFrameTypes.d.ts +78 -0
- package/dist/esm/packages/teams-js/dts/internal/appHelpers.d.ts +19 -0
- package/dist/esm/packages/teams-js/dts/internal/childCommunication.d.ts +38 -0
- package/dist/esm/packages/teams-js/dts/internal/communication.d.ts +151 -0
- package/dist/esm/packages/teams-js/dts/internal/communicationUtils.d.ts +20 -0
- package/dist/esm/packages/teams-js/dts/internal/constants.d.ts +146 -0
- package/dist/esm/packages/teams-js/dts/internal/deepLinkConstants.d.ts +26 -0
- package/dist/esm/packages/teams-js/dts/internal/deepLinkUtilities.d.ts +4 -0
- package/dist/esm/packages/teams-js/dts/internal/dialogHelpers.d.ts +32 -0
- package/dist/esm/packages/teams-js/dts/internal/emailAddressValidation.d.ts +1 -0
- package/dist/esm/packages/teams-js/dts/internal/globalVars.d.ts +13 -0
- package/dist/esm/packages/teams-js/dts/internal/handlers.d.ts +101 -0
- package/dist/esm/packages/teams-js/dts/internal/hostToAppTelemetry.d.ts +51 -0
- package/dist/esm/packages/teams-js/dts/internal/idValidation.d.ts +37 -0
- package/dist/esm/packages/teams-js/dts/internal/interfaces.d.ts +58 -0
- package/dist/esm/packages/teams-js/dts/internal/internalAPIs.d.ts +61 -0
- package/dist/esm/packages/teams-js/dts/internal/marketplaceUtils.d.ts +94 -0
- package/dist/esm/packages/teams-js/dts/internal/mediaUtil.d.ts +95 -0
- package/dist/esm/packages/teams-js/dts/internal/messageObjects.d.ts +80 -0
- package/dist/esm/packages/teams-js/dts/internal/nestedAppAuthUtils.d.ts +107 -0
- package/dist/esm/packages/teams-js/dts/internal/pagesHelpers.d.ts +27 -0
- package/dist/esm/packages/teams-js/dts/internal/profileUtil.d.ts +33 -0
- package/dist/esm/packages/teams-js/dts/internal/responseHandler.d.ts +32 -0
- package/dist/esm/packages/teams-js/dts/internal/telemetry.d.ts +411 -0
- package/dist/esm/packages/teams-js/dts/internal/typeCheckUtilities.d.ts +1 -0
- package/dist/esm/packages/teams-js/dts/internal/urlPattern.d.ts +50 -0
- package/dist/esm/packages/teams-js/dts/internal/utils.d.ts +226 -0
- package/dist/esm/packages/teams-js/dts/internal/validOrigins.d.ts +13 -0
- package/dist/esm/packages/teams-js/dts/internal/videoEffectsUtils.d.ts +31 -0
- package/dist/esm/packages/teams-js/dts/internal/videoFrameTick.d.ts +10 -0
- package/dist/esm/packages/teams-js/dts/internal/videoPerformanceMonitor.d.ts +54 -0
- package/dist/esm/packages/teams-js/dts/internal/videoPerformanceStatistics.d.ts +49 -0
- package/dist/esm/packages/teams-js/dts/internal/visualMediaHelpers.d.ts +14 -0
- package/dist/esm/packages/teams-js/dts/internal/webStorageHelpers.d.ts +4 -0
- package/dist/esm/packages/teams-js/dts/private/appEntity.d.ts +89 -0
- package/dist/esm/packages/teams-js/dts/private/constants.d.ts +9 -0
- package/dist/esm/packages/teams-js/dts/private/conversations.d.ts +152 -0
- package/dist/esm/packages/teams-js/dts/private/copilot/copilot.d.ts +5 -0
- package/dist/esm/packages/teams-js/dts/private/copilot/customTelemetry.d.ts +33 -0
- package/dist/esm/packages/teams-js/dts/private/copilot/eligibility.d.ts +31 -0
- package/dist/esm/packages/teams-js/dts/private/copilot/sidePanel.d.ts +75 -0
- package/dist/esm/packages/teams-js/dts/private/copilot/sidePanelInterfaces.d.ts +522 -0
- package/dist/esm/packages/teams-js/dts/private/copilot/view.d.ts +21 -0
- package/dist/esm/packages/teams-js/dts/private/externalAppAuthentication.d.ts +472 -0
- package/dist/esm/packages/teams-js/dts/private/externalAppAuthenticationForCEA.d.ts +93 -0
- package/dist/esm/packages/teams-js/dts/private/externalAppCardActions.d.ts +111 -0
- package/dist/esm/packages/teams-js/dts/private/externalAppCardActionsForCEA.d.ts +48 -0
- package/dist/esm/packages/teams-js/dts/private/externalAppCardActionsForDA.d.ts +75 -0
- package/dist/esm/packages/teams-js/dts/private/externalAppCommands.d.ts +122 -0
- package/dist/esm/packages/teams-js/dts/private/externalAppErrorHandling.d.ts +19 -0
- package/dist/esm/packages/teams-js/dts/private/files.d.ts +766 -0
- package/dist/esm/packages/teams-js/dts/private/hostEntity/hostEntity.d.ts +50 -0
- package/dist/esm/packages/teams-js/dts/private/hostEntity/tab.d.ts +134 -0
- package/dist/esm/packages/teams-js/dts/private/index.d.ts +29 -0
- package/dist/esm/packages/teams-js/dts/private/interfaces.d.ts +290 -0
- package/dist/esm/packages/teams-js/dts/private/logs.d.ts +31 -0
- package/dist/esm/packages/teams-js/dts/private/meetingRoom.d.ts +208 -0
- package/dist/esm/packages/teams-js/dts/private/messageChannels/dataLayer.d.ts +39 -0
- package/dist/esm/packages/teams-js/dts/private/messageChannels/messageChannels.d.ts +28 -0
- package/dist/esm/packages/teams-js/dts/private/messageChannels/telemetry.d.ts +39 -0
- package/dist/esm/packages/teams-js/dts/private/nestedAppAuth/nestedAppAuthBridge.d.ts +32 -0
- package/dist/esm/packages/teams-js/dts/private/notifications.d.ts +32 -0
- package/dist/esm/packages/teams-js/dts/private/otherAppStateChange.d.ts +94 -0
- package/dist/esm/packages/teams-js/dts/private/plugins.d.ts +94 -0
- package/dist/esm/packages/teams-js/dts/private/privateAPIs.d.ts +94 -0
- package/dist/esm/packages/teams-js/dts/private/remoteCamera.d.ts +303 -0
- package/dist/esm/packages/teams-js/dts/private/store.d.ts +128 -0
- package/dist/esm/packages/teams-js/dts/private/teams/fullTrust/fullTrust.d.ts +31 -0
- package/dist/esm/packages/teams-js/dts/private/teams/fullTrust/joinedTeams.d.ts +30 -0
- package/dist/esm/packages/teams-js/dts/private/teams/teams.d.ts +63 -0
- package/dist/esm/packages/teams-js/dts/private/videoEffectsEx.d.ts +250 -0
- package/dist/esm/packages/teams-js/dts/private/widgetHosting/widgetContext.d.ts +121 -0
- package/dist/esm/packages/teams-js/dts/private/widgetHosting/widgetHosting.d.ts +101 -0
- package/dist/esm/packages/teams-js/dts/public/adaptiveCards.d.ts +6 -0
- package/dist/esm/packages/teams-js/dts/public/app/app.d.ts +648 -0
- package/dist/esm/packages/teams-js/dts/public/app/lifecycle.d.ts +41 -0
- package/dist/esm/packages/teams-js/dts/public/appId.d.ts +28 -0
- package/dist/esm/packages/teams-js/dts/public/appInitialization.d.ts +57 -0
- package/dist/esm/packages/teams-js/dts/public/appInstallDialog.d.ts +18 -0
- package/dist/esm/packages/teams-js/dts/public/appPerformanceMetrics.d.ts +24 -0
- package/dist/esm/packages/teams-js/dts/public/appWindow.d.ts +66 -0
- package/dist/esm/packages/teams-js/dts/public/authentication.d.ts +417 -0
- package/dist/esm/packages/teams-js/dts/public/badge.d.ts +42 -0
- package/dist/esm/packages/teams-js/dts/public/barCode.d.ts +54 -0
- package/dist/esm/packages/teams-js/dts/public/calendar.d.ts +41 -0
- package/dist/esm/packages/teams-js/dts/public/call.d.ts +54 -0
- package/dist/esm/packages/teams-js/dts/public/chat.d.ts +68 -0
- package/dist/esm/packages/teams-js/dts/public/clipboard.d.ts +35 -0
- package/dist/esm/packages/teams-js/dts/public/connectivity.d.ts +52 -0
- package/dist/esm/packages/teams-js/dts/public/constants.d.ts +203 -0
- package/dist/esm/packages/teams-js/dts/public/dialog/adaptiveCard/adaptiveCard.d.ts +22 -0
- package/dist/esm/packages/teams-js/dts/public/dialog/adaptiveCard/bot.d.ts +22 -0
- package/dist/esm/packages/teams-js/dts/public/dialog/dialog.d.ts +49 -0
- package/dist/esm/packages/teams-js/dts/public/dialog/update.d.ts +19 -0
- package/dist/esm/packages/teams-js/dts/public/dialog/url/bot.d.ts +25 -0
- package/dist/esm/packages/teams-js/dts/public/dialog/url/parentCommunication.d.ts +41 -0
- package/dist/esm/packages/teams-js/dts/public/dialog/url/url.d.ts +54 -0
- package/dist/esm/packages/teams-js/dts/public/emailAddress.d.ts +12 -0
- package/dist/esm/packages/teams-js/dts/public/externalApp.d.ts +130 -0
- package/dist/esm/packages/teams-js/dts/public/featureFlags.d.ts +44 -0
- package/dist/esm/packages/teams-js/dts/public/geoLocation/geoLocation.d.ts +68 -0
- package/dist/esm/packages/teams-js/dts/public/geoLocation/map.d.ts +33 -0
- package/dist/esm/packages/teams-js/dts/public/haptics.d.ts +42 -0
- package/dist/esm/packages/teams-js/dts/public/index.d.ts +57 -0
- package/dist/esm/packages/teams-js/dts/public/interfaces.d.ts +1321 -0
- package/dist/esm/packages/teams-js/dts/public/liveShareHost.d.ts +220 -0
- package/dist/esm/packages/teams-js/dts/public/location.d.ts +85 -0
- package/dist/esm/packages/teams-js/dts/public/mail/handoff.d.ts +48 -0
- package/dist/esm/packages/teams-js/dts/public/mail/mail.d.ts +97 -0
- package/dist/esm/packages/teams-js/dts/public/marketplace.d.ts +320 -0
- package/dist/esm/packages/teams-js/dts/public/media.d.ts +435 -0
- package/dist/esm/packages/teams-js/dts/public/meeting/appShareButton.d.ts +51 -0
- package/dist/esm/packages/teams-js/dts/public/meeting/meeting.d.ts +854 -0
- package/dist/esm/packages/teams-js/dts/public/menus.d.ts +187 -0
- package/dist/esm/packages/teams-js/dts/public/monetization.d.ts +64 -0
- package/dist/esm/packages/teams-js/dts/public/navigation.d.ts +46 -0
- package/dist/esm/packages/teams-js/dts/public/nestedAppAuth.d.ts +64 -0
- package/dist/esm/packages/teams-js/dts/public/offlineStorage/drafts.d.ts +104 -0
- package/dist/esm/packages/teams-js/dts/public/offlineStorage/inbox.d.ts +86 -0
- package/dist/esm/packages/teams-js/dts/public/offlineStorage/offlineStorage.d.ts +258 -0
- package/dist/esm/packages/teams-js/dts/public/offlineStorage/outbox.d.ts +112 -0
- package/dist/esm/packages/teams-js/dts/public/offlineStorage/sent.d.ts +69 -0
- package/dist/esm/packages/teams-js/dts/public/offlineStorage/sync.d.ts +183 -0
- package/dist/esm/packages/teams-js/dts/public/pages/appButton.d.ts +30 -0
- package/dist/esm/packages/teams-js/dts/public/pages/backStack.d.ts +44 -0
- package/dist/esm/packages/teams-js/dts/public/pages/config.d.ts +123 -0
- package/dist/esm/packages/teams-js/dts/public/pages/currentApp.d.ts +46 -0
- package/dist/esm/packages/teams-js/dts/public/pages/fullTrust.d.ts +33 -0
- package/dist/esm/packages/teams-js/dts/public/pages/pages.d.ts +253 -0
- package/dist/esm/packages/teams-js/dts/public/pages/tabs.d.ts +32 -0
- package/dist/esm/packages/teams-js/dts/public/people.d.ts +73 -0
- package/dist/esm/packages/teams-js/dts/public/profile.d.ts +105 -0
- package/dist/esm/packages/teams-js/dts/public/publicAPIs.d.ts +218 -0
- package/dist/esm/packages/teams-js/dts/public/runtime.d.ts +240 -0
- package/dist/esm/packages/teams-js/dts/public/search.d.ts +90 -0
- package/dist/esm/packages/teams-js/dts/public/secondaryBrowser.d.ts +31 -0
- package/dist/esm/packages/teams-js/dts/public/security.d.ts +83 -0
- package/dist/esm/packages/teams-js/dts/public/serializable.interface.d.ts +17 -0
- package/dist/esm/packages/teams-js/dts/public/settings.d.ts +102 -0
- package/dist/esm/packages/teams-js/dts/public/sharing/history.d.ts +47 -0
- package/dist/esm/packages/teams-js/dts/public/sharing/sharing.d.ts +93 -0
- package/dist/esm/packages/teams-js/dts/public/shortcutRelay.d.ts +53 -0
- package/dist/esm/packages/teams-js/dts/public/stageView/self.d.ts +23 -0
- package/dist/esm/packages/teams-js/dts/public/stageView/stageView.d.ts +81 -0
- package/dist/esm/packages/teams-js/dts/public/tasks.d.ts +52 -0
- package/dist/esm/packages/teams-js/dts/public/teamsAPIs.d.ts +79 -0
- package/dist/esm/packages/teams-js/dts/public/thirdPartyCloudStorage.d.ts +118 -0
- package/dist/esm/packages/teams-js/dts/public/uuidObject.d.ts +38 -0
- package/dist/esm/packages/teams-js/dts/public/validatedSafeString.d.ts +25 -0
- package/dist/esm/packages/teams-js/dts/public/version.d.ts +5 -0
- package/dist/esm/packages/teams-js/dts/public/videoEffects.d.ts +212 -0
- package/dist/esm/packages/teams-js/dts/public/visualMedia/image.d.ts +64 -0
- package/dist/esm/packages/teams-js/dts/public/visualMedia/visualMedia.d.ts +116 -0
- package/dist/esm/packages/teams-js/dts/public/webStorage.d.ts +25 -0
- package/dist/esm/packages/teams-js/src/artifactsForCDN/validDomains.json.js +1 -0
- package/dist/esm/packages/teams-js/src/index.js +1 -0
- package/dist/esm/packages/teams-js/src/internal/appHelpers.js +1 -0
- package/dist/esm/packages/teams-js/src/internal/childCommunication.js +1 -0
- package/dist/esm/packages/teams-js/src/internal/communication.js +1 -0
- package/dist/esm/packages/teams-js/src/internal/communicationUtils.js +1 -0
- package/dist/esm/packages/teams-js/src/internal/constants.js +1 -0
- package/dist/esm/packages/teams-js/src/internal/deepLinkConstants.js +1 -0
- package/dist/esm/packages/teams-js/src/internal/deepLinkUtilities.js +1 -0
- package/dist/esm/packages/teams-js/src/internal/dialogHelpers.js +1 -0
- package/dist/esm/packages/teams-js/src/internal/emailAddressValidation.js +1 -0
- package/dist/esm/packages/teams-js/src/internal/globalVars.js +1 -0
- package/dist/esm/packages/teams-js/src/internal/handlers.js +1 -0
- package/dist/esm/packages/teams-js/src/internal/hostToAppTelemetry.js +1 -0
- package/dist/esm/packages/teams-js/src/internal/idValidation.js +1 -0
- package/dist/esm/packages/teams-js/src/internal/internalAPIs.js +1 -0
- package/dist/esm/packages/teams-js/src/internal/marketplaceUtils.js +1 -0
- package/dist/esm/packages/teams-js/src/internal/mediaUtil.js +1 -0
- package/dist/esm/packages/teams-js/src/internal/messageObjects.js +1 -0
- package/dist/esm/packages/teams-js/src/internal/nestedAppAuthUtils.js +1 -0
- package/dist/esm/packages/teams-js/src/internal/pagesHelpers.js +1 -0
- package/dist/esm/packages/teams-js/src/internal/profileUtil.js +1 -0
- package/dist/esm/packages/teams-js/src/internal/responseHandler.js +1 -0
- package/dist/esm/packages/teams-js/src/internal/telemetry.js +1 -0
- package/dist/esm/packages/teams-js/src/internal/typeCheckUtilities.js +1 -0
- package/dist/esm/packages/teams-js/src/internal/urlPattern.js +1 -0
- package/dist/esm/packages/teams-js/src/internal/utils.js +1 -0
- package/dist/esm/packages/teams-js/src/internal/validOrigins.js +1 -0
- package/dist/esm/packages/teams-js/src/internal/videoEffectsUtils.js +1 -0
- package/dist/esm/packages/teams-js/src/internal/videoFrameTick.js +1 -0
- package/dist/esm/packages/teams-js/src/internal/videoPerformanceMonitor.js +1 -0
- package/dist/esm/packages/teams-js/src/internal/videoPerformanceStatistics.js +1 -0
- package/dist/esm/packages/teams-js/src/internal/visualMediaHelpers.js +1 -0
- package/dist/esm/packages/teams-js/src/internal/webStorageHelpers.js +1 -0
- package/dist/esm/packages/teams-js/src/private/appEntity.js +1 -0
- package/dist/esm/packages/teams-js/src/private/constants.js +1 -0
- package/dist/esm/packages/teams-js/src/private/conversations.js +1 -0
- package/dist/esm/packages/teams-js/src/private/copilot/copilot.js +1 -0
- package/dist/esm/packages/teams-js/src/private/copilot/customTelemetry.js +1 -0
- package/dist/esm/packages/teams-js/src/private/copilot/eligibility.js +1 -0
- package/dist/esm/packages/teams-js/src/private/copilot/sidePanel.js +1 -0
- package/dist/esm/packages/teams-js/src/private/copilot/sidePanelInterfaces.js +1 -0
- package/dist/esm/packages/teams-js/src/private/copilot/view.js +1 -0
- package/dist/esm/packages/teams-js/src/private/externalAppAuthentication.js +1 -0
- package/dist/esm/packages/teams-js/src/private/externalAppAuthenticationForCEA.js +1 -0
- package/dist/esm/packages/teams-js/src/private/externalAppCardActions.js +1 -0
- package/dist/esm/packages/teams-js/src/private/externalAppCardActionsForCEA.js +1 -0
- package/dist/esm/packages/teams-js/src/private/externalAppCardActionsForDA.js +1 -0
- package/dist/esm/packages/teams-js/src/private/externalAppCommands.js +1 -0
- package/dist/esm/packages/teams-js/src/private/externalAppErrorHandling.js +1 -0
- package/dist/esm/packages/teams-js/src/private/files.js +1 -0
- package/dist/esm/packages/teams-js/src/private/hostEntity/hostEntity.js +1 -0
- package/dist/esm/packages/teams-js/src/private/hostEntity/tab.js +1 -0
- package/dist/esm/packages/teams-js/src/private/interfaces.js +1 -0
- package/dist/esm/packages/teams-js/src/private/logs.js +1 -0
- package/dist/esm/packages/teams-js/src/private/meetingRoom.js +1 -0
- package/dist/esm/packages/teams-js/src/private/messageChannels/dataLayer.js +1 -0
- package/dist/esm/packages/teams-js/src/private/messageChannels/messageChannels.js +1 -0
- package/dist/esm/packages/teams-js/src/private/messageChannels/telemetry.js +1 -0
- package/dist/esm/packages/teams-js/src/private/nestedAppAuth/nestedAppAuthBridge.js +1 -0
- package/dist/esm/packages/teams-js/src/private/notifications.js +1 -0
- package/dist/esm/packages/teams-js/src/private/otherAppStateChange.js +1 -0
- package/dist/esm/packages/teams-js/src/private/plugins.js +1 -0
- package/dist/esm/packages/teams-js/src/private/privateAPIs.js +1 -0
- package/dist/esm/packages/teams-js/src/private/remoteCamera.js +1 -0
- package/dist/esm/packages/teams-js/src/private/store.js +1 -0
- package/dist/esm/packages/teams-js/src/private/teams/fullTrust/fullTrust.js +1 -0
- package/dist/esm/packages/teams-js/src/private/teams/fullTrust/joinedTeams.js +1 -0
- package/dist/esm/packages/teams-js/src/private/teams/teams.js +1 -0
- package/dist/esm/packages/teams-js/src/private/videoEffectsEx.js +1 -0
- package/dist/esm/packages/teams-js/src/private/widgetHosting/widgetHosting.js +1 -0
- package/dist/esm/packages/teams-js/src/public/adaptiveCards.js +1 -0
- package/dist/esm/packages/teams-js/src/public/app/app.js +1 -0
- package/dist/esm/packages/teams-js/src/public/app/lifecycle.js +1 -0
- package/dist/esm/packages/teams-js/src/public/appId.js +1 -0
- package/dist/esm/packages/teams-js/src/public/appInitialization.js +1 -0
- package/dist/esm/packages/teams-js/src/public/appInstallDialog.js +1 -0
- package/dist/esm/packages/teams-js/src/public/appPerformanceMetrics.js +1 -0
- package/dist/esm/packages/teams-js/src/public/appWindow.js +1 -0
- package/dist/esm/packages/teams-js/src/public/authentication.js +1 -0
- package/dist/esm/packages/teams-js/src/public/badge.js +1 -0
- package/dist/esm/packages/teams-js/src/public/barCode.js +1 -0
- package/dist/esm/packages/teams-js/src/public/calendar.js +1 -0
- package/dist/esm/packages/teams-js/src/public/call.js +1 -0
- package/dist/esm/packages/teams-js/src/public/chat.js +1 -0
- package/dist/esm/packages/teams-js/src/public/clipboard.js +1 -0
- package/dist/esm/packages/teams-js/src/public/connectivity.js +1 -0
- package/dist/esm/packages/teams-js/src/public/constants.js +1 -0
- package/dist/esm/packages/teams-js/src/public/dialog/adaptiveCard/adaptiveCard.js +1 -0
- package/dist/esm/packages/teams-js/src/public/dialog/adaptiveCard/bot.js +1 -0
- package/dist/esm/packages/teams-js/src/public/dialog/dialog.js +1 -0
- package/dist/esm/packages/teams-js/src/public/dialog/update.js +1 -0
- package/dist/esm/packages/teams-js/src/public/dialog/url/bot.js +1 -0
- package/dist/esm/packages/teams-js/src/public/dialog/url/parentCommunication.js +1 -0
- package/dist/esm/packages/teams-js/src/public/dialog/url/url.js +1 -0
- package/dist/esm/packages/teams-js/src/public/emailAddress.js +1 -0
- package/dist/esm/packages/teams-js/src/public/externalApp.js +1 -0
- package/dist/esm/packages/teams-js/src/public/featureFlags.js +1 -0
- package/dist/esm/packages/teams-js/src/public/geoLocation/geoLocation.js +1 -0
- package/dist/esm/packages/teams-js/src/public/geoLocation/map.js +1 -0
- package/dist/esm/packages/teams-js/src/public/haptics.js +1 -0
- package/dist/esm/packages/teams-js/src/public/interfaces.js +1 -0
- package/dist/esm/packages/teams-js/src/public/liveShareHost.js +1 -0
- package/dist/esm/packages/teams-js/src/public/location.js +1 -0
- package/dist/esm/packages/teams-js/src/public/mail/handoff.js +1 -0
- package/dist/esm/packages/teams-js/src/public/mail/mail.js +1 -0
- package/dist/esm/packages/teams-js/src/public/marketplace.js +1 -0
- package/dist/esm/packages/teams-js/src/public/media.js +1 -0
- package/dist/esm/packages/teams-js/src/public/meeting/appShareButton.js +1 -0
- package/dist/esm/packages/teams-js/src/public/meeting/meeting.js +1 -0
- package/dist/esm/packages/teams-js/src/public/menus.js +1 -0
- package/dist/esm/packages/teams-js/src/public/monetization.js +1 -0
- package/dist/esm/packages/teams-js/src/public/navigation.js +1 -0
- package/dist/esm/packages/teams-js/src/public/nestedAppAuth.js +1 -0
- package/dist/esm/packages/teams-js/src/public/offlineStorage/drafts.js +1 -0
- package/dist/esm/packages/teams-js/src/public/offlineStorage/inbox.js +1 -0
- package/dist/esm/packages/teams-js/src/public/offlineStorage/offlineStorage.js +1 -0
- package/dist/esm/packages/teams-js/src/public/offlineStorage/outbox.js +1 -0
- package/dist/esm/packages/teams-js/src/public/offlineStorage/sent.js +1 -0
- package/dist/esm/packages/teams-js/src/public/offlineStorage/sync.js +1 -0
- package/dist/esm/packages/teams-js/src/public/pages/appButton.js +1 -0
- package/dist/esm/packages/teams-js/src/public/pages/backStack.js +1 -0
- package/dist/esm/packages/teams-js/src/public/pages/config.js +1 -0
- package/dist/esm/packages/teams-js/src/public/pages/currentApp.js +1 -0
- package/dist/esm/packages/teams-js/src/public/pages/fullTrust.js +1 -0
- package/dist/esm/packages/teams-js/src/public/pages/pages.js +1 -0
- package/dist/esm/packages/teams-js/src/public/pages/tabs.js +1 -0
- package/dist/esm/packages/teams-js/src/public/people.js +1 -0
- package/dist/esm/packages/teams-js/src/public/profile.js +1 -0
- package/dist/esm/packages/teams-js/src/public/publicAPIs.js +1 -0
- package/dist/esm/packages/teams-js/src/public/runtime.js +1 -0
- package/dist/esm/packages/teams-js/src/public/search.js +1 -0
- package/dist/esm/packages/teams-js/src/public/secondaryBrowser.js +1 -0
- package/dist/esm/packages/teams-js/src/public/security.js +1 -0
- package/dist/esm/packages/teams-js/src/public/serializable.interface.js +1 -0
- package/dist/esm/packages/teams-js/src/public/settings.js +1 -0
- package/dist/esm/packages/teams-js/src/public/sharing/history.js +1 -0
- package/dist/esm/packages/teams-js/src/public/sharing/sharing.js +1 -0
- package/dist/esm/packages/teams-js/src/public/shortcutRelay.js +1 -0
- package/dist/esm/packages/teams-js/src/public/stageView/self.js +1 -0
- package/dist/esm/packages/teams-js/src/public/stageView/stageView.js +1 -0
- package/dist/esm/packages/teams-js/src/public/tasks.js +1 -0
- package/dist/esm/packages/teams-js/src/public/teamsAPIs.js +1 -0
- package/dist/esm/packages/teams-js/src/public/thirdPartyCloudStorage.js +1 -0
- package/dist/esm/packages/teams-js/src/public/uuidObject.js +1 -0
- package/dist/esm/packages/teams-js/src/public/validatedSafeString.js +1 -0
- package/dist/esm/packages/teams-js/src/public/version.js +1 -0
- package/dist/esm/packages/teams-js/src/public/videoEffects.js +1 -0
- package/dist/esm/packages/teams-js/src/public/visualMedia/image.js +1 -0
- package/dist/esm/packages/teams-js/src/public/visualMedia/visualMedia.js +1 -0
- package/dist/esm/packages/teams-js/src/public/webStorage.js +1 -0
- package/dist/umd/JevelinBridge-manifest.json +642 -0
- package/dist/umd/JevelinBridge.js +23119 -0
- package/dist/umd/JevelinBridge.js.map +1 -0
- package/dist/umd/JevelinBridge.min.js +3 -0
- package/dist/umd/JevelinBridge.min.js.LICENSE.txt +8 -0
- package/dist/umd/JevelinBridge.min.js.map +1 -0
- package/package.json +53 -0
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import { ValidatedSafeString } from './validatedSafeString';
|
|
2
|
+
/**
|
|
3
|
+
* A strongly-typed class used to represent a "valid" app id.
|
|
4
|
+
*
|
|
5
|
+
* Valid is a relative term, in this case. Truly valid app ids are UUIDs as documented in the schema:
|
|
6
|
+
* https://learn.microsoft.com/en-us/microsoftteams/platform/resources/schema/manifest-schema#id
|
|
7
|
+
* However, there are some older internal/hard-coded apps which violate this schema and use names like
|
|
8
|
+
* com.microsoft.teamspace.tab.youtube. For compatibility with these legacy apps, we unfortunately cannot
|
|
9
|
+
* securely and completely validate app ids as UUIDs. Based on this, the validation is limited to checking
|
|
10
|
+
* for script tags, length, and non-printable characters. Validation will be updated in the future to ensure
|
|
11
|
+
* the app id is a valid UUID as legacy apps update.
|
|
12
|
+
*/
|
|
13
|
+
export declare class AppId extends ValidatedSafeString {
|
|
14
|
+
/**
|
|
15
|
+
* Creates a strongly-typed AppId from a string
|
|
16
|
+
*
|
|
17
|
+
* @param appIdAsString An app id represented as a string
|
|
18
|
+
* @throws Error with a message describing the exact validation violation
|
|
19
|
+
*/
|
|
20
|
+
constructor(appIdAsString: string);
|
|
21
|
+
/**
|
|
22
|
+
* Returns a JSON representation of the AppId object
|
|
23
|
+
* @returns A JSON representation of the AppId object
|
|
24
|
+
*
|
|
25
|
+
* note: this method maintains backward compatibility for JSON serialization
|
|
26
|
+
*/
|
|
27
|
+
toJSON(): object;
|
|
28
|
+
}
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
import { ExpectedFailureReason, FailedReason, IExpectedFailureRequest, IFailedRequest, Messages } from './app/app';
|
|
2
|
+
/**
|
|
3
|
+
* @deprecated
|
|
4
|
+
* As of TeamsJS v2.0.0, please use {@link app.Messages} instead.
|
|
5
|
+
*/
|
|
6
|
+
export { Messages };
|
|
7
|
+
/**
|
|
8
|
+
* @deprecated
|
|
9
|
+
* As of TeamsJS v2.0.0, please use {@link app.FailedReason} instead.
|
|
10
|
+
*/
|
|
11
|
+
export { FailedReason };
|
|
12
|
+
/**
|
|
13
|
+
* @deprecated
|
|
14
|
+
* As of TeamsJS v2.0.0, please use {@link app.ExpectedFailureReason} instead.
|
|
15
|
+
*/
|
|
16
|
+
export { ExpectedFailureReason };
|
|
17
|
+
/**
|
|
18
|
+
* @deprecated
|
|
19
|
+
* As of TeamsJS v2.0.0, please use {@link app.IFailedRequest} instead.
|
|
20
|
+
*/
|
|
21
|
+
export { IFailedRequest };
|
|
22
|
+
/**
|
|
23
|
+
* @deprecated
|
|
24
|
+
* As of TeamsJS v2.0.0, please use {@link app.IExpectedFailureRequest} instead.
|
|
25
|
+
*/
|
|
26
|
+
export { IExpectedFailureRequest };
|
|
27
|
+
/**
|
|
28
|
+
* @deprecated
|
|
29
|
+
* As of TeamsJS v2.0.0, please use {@link app.notifyAppLoaded app.notifyAppLoaded(): void} instead.
|
|
30
|
+
*
|
|
31
|
+
* Notifies the frame that app has loaded and to hide the loading indicator if one is shown.
|
|
32
|
+
*/
|
|
33
|
+
export declare function notifyAppLoaded(): void;
|
|
34
|
+
/**
|
|
35
|
+
* @deprecated
|
|
36
|
+
* As of TeamsJS v2.0.0, please use {@link app.notifySuccess app.notifySuccess(): Promise<NotifySuccessResponse>} instead.
|
|
37
|
+
*
|
|
38
|
+
* Notifies the frame that app initialization is successful and is ready for user interaction.
|
|
39
|
+
*/
|
|
40
|
+
export declare function notifySuccess(): void;
|
|
41
|
+
/**
|
|
42
|
+
* @deprecated
|
|
43
|
+
* As of TeamsJS v2.0.0, please use {@link app.notifyFailure app.notifyFailure(appInitializationFailedRequest: IFailedRequest): void} instead.
|
|
44
|
+
*
|
|
45
|
+
* Notifies the frame that app initialization has failed and to show an error page in its place.
|
|
46
|
+
* @param appInitializationFailedRequest - The failure request containing the reason for why the app failed
|
|
47
|
+
* during initialization as well as an optional message.
|
|
48
|
+
*/
|
|
49
|
+
export declare function notifyFailure(appInitializationFailedRequest: IFailedRequest): void;
|
|
50
|
+
/**
|
|
51
|
+
* @deprecated
|
|
52
|
+
* As of TeamsJS v2.0.0, please use {@link app.notifyExpectedFailure app.notifyExpectedFailure(expectedFailureRequest: IExpectedFailureRequest): void} instead.
|
|
53
|
+
*
|
|
54
|
+
* Notifies the frame that app initialized with some expected errors.
|
|
55
|
+
* @param expectedFailureRequest - The expected failure request containing the reason and an optional message
|
|
56
|
+
*/
|
|
57
|
+
export declare function notifyExpectedFailure(expectedFailureRequest: IExpectedFailureRequest): void;
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
/** Represents set of parameters needed to open the appInstallDialog. */
|
|
2
|
+
export interface OpenAppInstallDialogParams {
|
|
3
|
+
/** A unique identifier for the app being installed. */
|
|
4
|
+
appId: string;
|
|
5
|
+
}
|
|
6
|
+
/**
|
|
7
|
+
* Displays a dialog box that allows users to install a specific app within the host environment.
|
|
8
|
+
*
|
|
9
|
+
* @param openAPPInstallDialogParams - See {@link OpenAppInstallDialogParams | OpenAppInstallDialogParams} for more information.
|
|
10
|
+
*/
|
|
11
|
+
export declare function openAppInstallDialog(openAPPInstallDialogParams: OpenAppInstallDialogParams): Promise<void>;
|
|
12
|
+
/**
|
|
13
|
+
* Checks if the appInstallDialog capability is supported by the host
|
|
14
|
+
* @returns boolean to represent whether the appInstallDialog capability is supported
|
|
15
|
+
*
|
|
16
|
+
* @throws Error if {@linkcode app.initialize} has not successfully completed
|
|
17
|
+
*/
|
|
18
|
+
export declare function isSupported(): boolean;
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import { HostMemoryMetrics } from './interfaces';
|
|
2
|
+
/**
|
|
3
|
+
* @beta
|
|
4
|
+
* Indicates whether the app performance metrics capability is supported in the current host.
|
|
5
|
+
* @returns boolean to represent whether the shortcutRelay capability is supported
|
|
6
|
+
*
|
|
7
|
+
* @throws Error if {@link app.initialize} has not successfully completed
|
|
8
|
+
*
|
|
9
|
+
*/
|
|
10
|
+
export declare function isSupported(): boolean;
|
|
11
|
+
/**
|
|
12
|
+
* This function is passed to registerHostMemoryMetricsHandler. See {@link HostMemoryMetrics} to see which metrics are passed to the handler during a certain interval of time.
|
|
13
|
+
*/
|
|
14
|
+
export type HostMemoryMetricsHandler = (metrics: HostMemoryMetrics) => void;
|
|
15
|
+
/**
|
|
16
|
+
* @beta
|
|
17
|
+
* Registers a function to handle memory metrics heartbeat sent from the host periodically.
|
|
18
|
+
*
|
|
19
|
+
* @remarks
|
|
20
|
+
* Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
|
|
21
|
+
*
|
|
22
|
+
* @param handler - The handler to invoke each time memory metrics heartbeat is received from the host.
|
|
23
|
+
*/
|
|
24
|
+
export declare function registerHostMemoryMetricsHandler(handler: HostMemoryMetricsHandler): void;
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
/** onComplete function type */
|
|
2
|
+
export type onCompleteFunctionType = (status: boolean, reason?: string) => void;
|
|
3
|
+
/** addEventListner function type */
|
|
4
|
+
export type addEventListnerFunctionType = (message: any) => void;
|
|
5
|
+
/** Represents a window or frame within the host app. */
|
|
6
|
+
export interface IAppWindow {
|
|
7
|
+
/**
|
|
8
|
+
* Send a message to the AppWindow.
|
|
9
|
+
*
|
|
10
|
+
* @param message - The message to send
|
|
11
|
+
* @param onComplete - The callback to know if the postMessage has been success/failed.
|
|
12
|
+
*/
|
|
13
|
+
postMessage(message: any, onComplete?: onCompleteFunctionType): void;
|
|
14
|
+
/**
|
|
15
|
+
* Add a listener that will be called when an event is received from this AppWindow.
|
|
16
|
+
*
|
|
17
|
+
* @param type - The event to listen to. Currently the only supported type is 'message'.
|
|
18
|
+
* @param listener - The listener that will be called
|
|
19
|
+
*/
|
|
20
|
+
addEventListener(type: string, listener: Function): void;
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* An object that application can utilize to establish communication
|
|
24
|
+
* with the child window it opened, which contains the corresponding task.
|
|
25
|
+
*/
|
|
26
|
+
export declare class ChildAppWindow implements IAppWindow {
|
|
27
|
+
/**
|
|
28
|
+
* Send a message to the ChildAppWindow.
|
|
29
|
+
*
|
|
30
|
+
* @param message - The message to send
|
|
31
|
+
* @param onComplete - The callback to know if the postMessage has been success/failed.
|
|
32
|
+
*/
|
|
33
|
+
postMessage(message: any, onComplete?: onCompleteFunctionType): void;
|
|
34
|
+
/**
|
|
35
|
+
* Add a listener that will be called when an event is received from the ChildAppWindow.
|
|
36
|
+
*
|
|
37
|
+
* @param type - The event to listen to. Currently the only supported type is 'message'.
|
|
38
|
+
* @param listener - The listener that will be called
|
|
39
|
+
*/
|
|
40
|
+
addEventListener(type: string, listener: addEventListnerFunctionType): void;
|
|
41
|
+
}
|
|
42
|
+
/**
|
|
43
|
+
* An object that is utilized to facilitate communication with a parent window
|
|
44
|
+
* that initiated the opening of current window. For instance, a dialog or task
|
|
45
|
+
* module would utilize it to transmit messages to the application that launched it.
|
|
46
|
+
*/
|
|
47
|
+
export declare class ParentAppWindow implements IAppWindow {
|
|
48
|
+
/** Represents a parent window or frame. */
|
|
49
|
+
private static _instance;
|
|
50
|
+
/** Get the parent window instance. */
|
|
51
|
+
static get Instance(): IAppWindow;
|
|
52
|
+
/**
|
|
53
|
+
* Send a message to the ParentAppWindow.
|
|
54
|
+
*
|
|
55
|
+
* @param message - The message to send
|
|
56
|
+
* @param onComplete - The callback to know if the postMessage has been success/failed.
|
|
57
|
+
*/
|
|
58
|
+
postMessage(message: any, onComplete?: onCompleteFunctionType): void;
|
|
59
|
+
/**
|
|
60
|
+
* Add a listener that will be called when an event is received from the ParentAppWindow.
|
|
61
|
+
*
|
|
62
|
+
* @param type - The event to listen to. Currently the only supported type is 'message'.
|
|
63
|
+
* @param listener - The listener that will be called
|
|
64
|
+
*/
|
|
65
|
+
addEventListener(type: string, listener: addEventListnerFunctionType): void;
|
|
66
|
+
}
|
|
@@ -0,0 +1,417 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Module to interact with the authentication-specific part of the SDK.
|
|
3
|
+
*
|
|
4
|
+
* This object is used for starting or completing authentication flows.
|
|
5
|
+
* @module
|
|
6
|
+
*/
|
|
7
|
+
/**
|
|
8
|
+
* @deprecated
|
|
9
|
+
* As of TeamsJS v2.0.0, this function has been deprecated in favor of a Promise-based pattern using {@link authentication.authenticate authentication.authenticate(authenticateParameters: AuthenticatePopUpParameters): Promise\<string\>}
|
|
10
|
+
*
|
|
11
|
+
* Registers handlers to be called with the result of an authentication flow triggered using {@link authentication.authenticate authentication.authenticate(authenticateParameters?: AuthenticateParameters): void}
|
|
12
|
+
*
|
|
13
|
+
* @param authenticateParameters - Configuration for authentication flow pop-up result communication
|
|
14
|
+
*/
|
|
15
|
+
export declare function registerAuthenticationHandlers(authenticateParameters: AuthenticateParameters): void;
|
|
16
|
+
/**
|
|
17
|
+
* Initiates an authentication flow which requires a new window.
|
|
18
|
+
* There are two primary uses for this function:
|
|
19
|
+
* 1. When your app needs to authenticate using a 3rd-party identity provider (not Microsoft Entra ID)
|
|
20
|
+
* 2. When your app needs to show authentication UI that is blocked from being shown in an iframe (e.g., Microsoft Entra consent prompts)
|
|
21
|
+
*
|
|
22
|
+
* For more details, see [Enable authentication using third-party OAuth provider](https://learn.microsoft.com/microsoftteams/platform/tabs/how-to/authentication/auth-flow-tab)
|
|
23
|
+
*
|
|
24
|
+
* This function is *not* needed for "standard" Microsoft Entra SSO usage. Using {@link getAuthToken} is usually sufficient in that case. For more, see
|
|
25
|
+
* [Enable SSO for tab apps](https://learn.microsoft.com/microsoftteams/platform/tabs/how-to/authentication/tab-sso-overview))
|
|
26
|
+
*
|
|
27
|
+
* @remarks
|
|
28
|
+
* The authentication flow must start and end from the same domain, otherwise success and failure messages won't be returned to the window that initiated the call.
|
|
29
|
+
* The [authentication flow](https://learn.microsoft.com/microsoftteams/platform/tabs/how-to/authentication/auth-flow-tab) starts and ends at an endpoint on
|
|
30
|
+
* your own service (with a redirect round-trip to the 3rd party identity provider in the middle).
|
|
31
|
+
*
|
|
32
|
+
* @param authenticateParameters - Parameters describing the authentication window used for executing the authentication flow
|
|
33
|
+
*
|
|
34
|
+
* @returns `Promise` that will be fulfilled with the result from the authentication pop-up, if successful. The string in this result is provided in the parameter
|
|
35
|
+
* passed by your app when it calls {@link authentication.notifySuccess authentication.notifySuccess(result?: string): void} in the pop-up window after returning from the identity provider redirect.
|
|
36
|
+
*
|
|
37
|
+
* @throws `Error` if the authentication request fails or is canceled by the user. This error is provided in the parameter passed by your app when it calls
|
|
38
|
+
* {@link authentication.notifyFailure authentication.notifyFailure(result?: string): void} in the pop-up window after returning from the identity provider redirect. However, in some cases it can also be provided by
|
|
39
|
+
* the infrastructure depending on the failure (e.g., a user cancelation)
|
|
40
|
+
*
|
|
41
|
+
*/
|
|
42
|
+
export declare function authenticate(authenticateParameters: AuthenticatePopUpParameters): Promise<string>;
|
|
43
|
+
/**
|
|
44
|
+
* @deprecated
|
|
45
|
+
* As of TeamsJS v2.0.0, please use {@link authentication.authenticate authentication.authenticate(authenticateParameters: AuthenticatePopUpParameters): Promise\<string\>} instead.
|
|
46
|
+
*
|
|
47
|
+
* The documentation for {@link authentication.authenticate authentication.authenticate(authenticateParameters: AuthenticatePopUpParameters): Promise\<string\>} applies
|
|
48
|
+
* to this function.
|
|
49
|
+
* The one difference is that instead of the result being returned via the `Promise`, the result is returned to the callback functions provided in the
|
|
50
|
+
* `authenticateParameters` parameter.
|
|
51
|
+
*
|
|
52
|
+
* @param authenticateParameters - Parameters describing the authentication window used for executing the authentication flow and callbacks used for indicating the result
|
|
53
|
+
*
|
|
54
|
+
*/
|
|
55
|
+
export declare function authenticate(authenticateParameters?: AuthenticateParameters): void;
|
|
56
|
+
/**
|
|
57
|
+
* Requests an Microsoft Entra token to be issued on behalf of your app in an SSO flow.
|
|
58
|
+
* The token is acquired from the cache if it is not expired. Otherwise a request is sent to Microsoft Entra to
|
|
59
|
+
* obtain a new token.
|
|
60
|
+
* This function is used to enable SSO scenarios. See [Enable SSO for tab apps](https://learn.microsoft.com/microsoftteams/platform/tabs/how-to/authentication/tab-sso-overview)
|
|
61
|
+
* for more details.
|
|
62
|
+
*
|
|
63
|
+
* @param authTokenRequest - An optional set of values that configure the token request.
|
|
64
|
+
*
|
|
65
|
+
* @returns `Promise` that will be resolved with the token, if successful.
|
|
66
|
+
*
|
|
67
|
+
* @throws `Error` if the request fails in some way
|
|
68
|
+
*/
|
|
69
|
+
export declare function getAuthToken(authTokenRequest?: AuthTokenRequestParameters): Promise<string>;
|
|
70
|
+
/**
|
|
71
|
+
* @deprecated
|
|
72
|
+
* As of TeamsJS v2.0.0, please use {@link authentication.getAuthToken authentication.getAuthToken(authTokenRequest: AuthTokenRequestParameters): Promise\<string\>} instead.
|
|
73
|
+
*
|
|
74
|
+
* The documentation {@link authentication.getAuthToken authentication.getAuthToken(authTokenRequest: AuthTokenRequestParameters): Promise\<string\>} applies to this
|
|
75
|
+
* function as well. The one difference when using this function is that the result is provided in the callbacks in the `authTokenRequest` parameter
|
|
76
|
+
* instead of as a `Promise`.
|
|
77
|
+
*
|
|
78
|
+
* @param authTokenRequest - An optional set of values that configure the token request.
|
|
79
|
+
* It contains callbacks to call in case of success/failure
|
|
80
|
+
*/
|
|
81
|
+
export declare function getAuthToken(authTokenRequest?: AuthTokenRequest): void;
|
|
82
|
+
/**
|
|
83
|
+
* @hidden
|
|
84
|
+
* Requests the decoded Microsoft Entra user identity on behalf of the app.
|
|
85
|
+
*
|
|
86
|
+
* @returns Promise that resolves with the {@link UserProfile}.
|
|
87
|
+
*
|
|
88
|
+
* @throws `Error` object in case of any problems, the most likely of which is that the calling app does not have appropriate permissions
|
|
89
|
+
* to call this method.
|
|
90
|
+
*
|
|
91
|
+
* @internal
|
|
92
|
+
* Limited to Microsoft-internal use
|
|
93
|
+
*/
|
|
94
|
+
export declare function getUser(): Promise<UserProfile>;
|
|
95
|
+
/**
|
|
96
|
+
* @deprecated
|
|
97
|
+
* As of TeamsJS v2.0.0, please use {@link authentication.getUser authentication.getUser(): Promise\<UserProfile\>} instead.
|
|
98
|
+
*
|
|
99
|
+
* @hidden
|
|
100
|
+
* Requests the decoded Microsoft Entra user identity on behalf of the app.
|
|
101
|
+
*
|
|
102
|
+
* @param userRequest - It passes success/failure callbacks in the userRequest object(deprecated)
|
|
103
|
+
*
|
|
104
|
+
* @throws `Error` object in case of any problems, the most likely of which is that the calling app does not have appropriate permissions
|
|
105
|
+
* to call this method.
|
|
106
|
+
*
|
|
107
|
+
* @internal
|
|
108
|
+
* Limited to Microsoft-internal use
|
|
109
|
+
*/
|
|
110
|
+
export declare function getUser(userRequest: UserRequest): void;
|
|
111
|
+
/**
|
|
112
|
+
* When using {@link authentication.authenticate authentication.authenticate(authenticateParameters: AuthenticatePopUpParameters): Promise\<string\>}, the
|
|
113
|
+
* window that was opened to execute the authentication flow should call this method after authentication to notify the caller of
|
|
114
|
+
* {@link authentication.authenticate authentication.authenticate(authenticateParameters: AuthenticatePopUpParameters): Promise\<string\>} that the
|
|
115
|
+
* authentication request was successful.
|
|
116
|
+
*
|
|
117
|
+
* @remarks
|
|
118
|
+
* The `result` parameter should **never** contain the token that was received from the identity provider, because a malicious app (rather than your own app) might have opened
|
|
119
|
+
* the authentication window. If that was the case, passing the token in this parameter would leak it to them. More secure methods for completing the authentication flow include:
|
|
120
|
+
* - For a purely browser-based experience (e.g., a personal app/tab app), you could store the token in browser local storage and then have your personal app retrieve it once
|
|
121
|
+
* this `notifySuccess` call is received.
|
|
122
|
+
* - For a server-based experience (e.g., a message extension), your authentication window could store the token on your service and then generate a unique code passed via this
|
|
123
|
+
* `result` parameter. The caller can then use the unique code to retrieve the token from your service.
|
|
124
|
+
*
|
|
125
|
+
* This function is usable only from an authentication window opened with {@link authentication.authenticate authentication.authenticate(authenticateParameters: AuthenticatePopUpParameters): Promise\<string\>}.
|
|
126
|
+
* This call causes the authentication window to be closed.
|
|
127
|
+
*
|
|
128
|
+
* @param result - Specifies a result for the authentication. If specified, the frame that initiated the authentication pop-up receives
|
|
129
|
+
* this value in its callback or via the `Promise` return value.
|
|
130
|
+
*
|
|
131
|
+
*/
|
|
132
|
+
export declare function notifySuccess(result?: string): void;
|
|
133
|
+
/**
|
|
134
|
+
* When using {@link authentication.authenticate authentication.authenticate(authenticateParameters: AuthenticatePopUpParameters): Promise\<string\>}, the
|
|
135
|
+
* window that was opened to execute the authentication flow should call this method after authentiction to notify the caller of
|
|
136
|
+
* {@link authentication.authenticate authentication.authenticate(authenticateParameters: AuthenticatePopUpParameters): Promise\<string\>} that the
|
|
137
|
+
* authentication request failed.
|
|
138
|
+
|
|
139
|
+
*
|
|
140
|
+
* @remarks
|
|
141
|
+
* This function is usable only on the authentication window.
|
|
142
|
+
* This call causes the authentication window to be closed.
|
|
143
|
+
*
|
|
144
|
+
* @param result - Specifies a result for the authentication. If specified, the frame that initiated the authentication pop-up receives
|
|
145
|
+
* this value in its callback or via the `Promise` return value
|
|
146
|
+
* @param _callbackUrl - This parameter is deprecated and unused
|
|
147
|
+
*/
|
|
148
|
+
export declare function notifyFailure(result?: string): void;
|
|
149
|
+
/**
|
|
150
|
+
* @deprecated
|
|
151
|
+
* As of TeamsJS v2.0.0, this interface has been deprecated in favor of leveraging the `Promise` returned from {@link authentication.authenticate authentication.authenticate(authenticateParameters: AuthenticatePopUpParameters): Promise\<string\>}
|
|
152
|
+
*-------------------------
|
|
153
|
+
* Used in {@link AuthenticateParameters} and {@link AuthTokenRequest}
|
|
154
|
+
*/
|
|
155
|
+
export interface LegacyCallBacks {
|
|
156
|
+
/**
|
|
157
|
+
* @deprecated
|
|
158
|
+
* As of TeamsJS v2.0.0, this property has been deprecated in favor of a Promise-based pattern.
|
|
159
|
+
*
|
|
160
|
+
* A function that is called if the request succeeds.
|
|
161
|
+
*/
|
|
162
|
+
successCallback?: (result: string) => void;
|
|
163
|
+
/**
|
|
164
|
+
* @deprecated
|
|
165
|
+
* As of TeamsJS v2.0.0, this property has been deprecated in favor of a Promise-based pattern.
|
|
166
|
+
*
|
|
167
|
+
* A function that is called if the request fails, with the reason for the failure.
|
|
168
|
+
*/
|
|
169
|
+
failureCallback?: (reason: string) => void;
|
|
170
|
+
}
|
|
171
|
+
/**
|
|
172
|
+
* Describes the authentication pop-up parameters
|
|
173
|
+
*/
|
|
174
|
+
export interface AuthenticatePopUpParameters {
|
|
175
|
+
/**
|
|
176
|
+
* The URL for the authentication pop-up.
|
|
177
|
+
*/
|
|
178
|
+
url: string;
|
|
179
|
+
/**
|
|
180
|
+
* The preferred width for the pop-up. This value can be ignored if outside the acceptable bounds.
|
|
181
|
+
*/
|
|
182
|
+
width?: number;
|
|
183
|
+
/**
|
|
184
|
+
* The preferred height for the pop-up. This value can be ignored if outside the acceptable bounds.
|
|
185
|
+
*/
|
|
186
|
+
height?: number;
|
|
187
|
+
/**
|
|
188
|
+
* Some identity providers restrict their authentication pages from being displayed in embedded browsers (e.g., a web view inside of a native application)
|
|
189
|
+
* If the identity provider you are using prevents embedded browser usage, this flag should be set to `true` to enable the authentication page specified in
|
|
190
|
+
* the {@link url} property to be opened in an external browser.
|
|
191
|
+
* If this flag is `false`, the page will be opened directly within the current hosting application.
|
|
192
|
+
*
|
|
193
|
+
* This flag is ignored when the host for the application is a web app (as opposed to a native application) as the behavior is unnecessary in a web-only
|
|
194
|
+
* environment without an embedded browser.
|
|
195
|
+
*/
|
|
196
|
+
isExternal?: boolean;
|
|
197
|
+
}
|
|
198
|
+
/**
|
|
199
|
+
* @deprecated
|
|
200
|
+
* As of TeamsJS v2.0.0, please use {@link authentication.authenticate authentication.authenticate(authenticateParameters: AuthenticatePopUpParameters): Promise\<string\>} and
|
|
201
|
+
* the associated {@link AuthenticatePopUpParameters} instead.
|
|
202
|
+
*
|
|
203
|
+
* @see {@link LegacyCallBacks}
|
|
204
|
+
*/
|
|
205
|
+
export type AuthenticateParameters = AuthenticatePopUpParameters & LegacyCallBacks;
|
|
206
|
+
/**
|
|
207
|
+
* Describes authentication token request parameters
|
|
208
|
+
*/
|
|
209
|
+
export interface AuthTokenRequestParameters {
|
|
210
|
+
/**
|
|
211
|
+
* @hidden
|
|
212
|
+
* @internal
|
|
213
|
+
* An list of resources for which to acquire the access token; only for internal Microsoft usage
|
|
214
|
+
*/
|
|
215
|
+
resources?: string[];
|
|
216
|
+
/**
|
|
217
|
+
* An optional list of claims which to pass to Microsoft Entra when requesting the access token.
|
|
218
|
+
*/
|
|
219
|
+
claims?: string[];
|
|
220
|
+
/**
|
|
221
|
+
* An optional flag indicating whether to attempt the token acquisition silently or allow a prompt to be shown.
|
|
222
|
+
*/
|
|
223
|
+
silent?: boolean;
|
|
224
|
+
/**
|
|
225
|
+
* An optional identifier of the home tenant for which to acquire the access token for (used in cross-tenant shared channels).
|
|
226
|
+
*/
|
|
227
|
+
tenantId?: string;
|
|
228
|
+
}
|
|
229
|
+
/**
|
|
230
|
+
* @deprecated
|
|
231
|
+
* As of TeamsJS v2.0.0, please use {@link AuthTokenRequestParameters} instead.
|
|
232
|
+
*/
|
|
233
|
+
export type AuthTokenRequest = AuthTokenRequestParameters & LegacyCallBacks;
|
|
234
|
+
/**
|
|
235
|
+
* @hidden
|
|
236
|
+
*
|
|
237
|
+
* @internal
|
|
238
|
+
* Limited to Microsoft-internal use
|
|
239
|
+
*/
|
|
240
|
+
export interface UserProfile {
|
|
241
|
+
/**
|
|
242
|
+
* @hidden
|
|
243
|
+
* The intended recipient of the token. The application that receives the token must verify that the audience
|
|
244
|
+
* value is correct and reject any tokens intended for a different audience.
|
|
245
|
+
*
|
|
246
|
+
* @internal
|
|
247
|
+
* Limited to Microsoft-internal use
|
|
248
|
+
*/
|
|
249
|
+
aud: string;
|
|
250
|
+
/**
|
|
251
|
+
* @hidden
|
|
252
|
+
* Identifies how the subject of the token was authenticated.
|
|
253
|
+
*
|
|
254
|
+
* @internal
|
|
255
|
+
* Limited to Microsoft-internal use
|
|
256
|
+
*/
|
|
257
|
+
amr: string[];
|
|
258
|
+
/**
|
|
259
|
+
* @hidden
|
|
260
|
+
* Stores the time at which the token was issued. It is often used to measure token freshness.
|
|
261
|
+
*
|
|
262
|
+
* @internal
|
|
263
|
+
* Limited to Microsoft-internal use
|
|
264
|
+
*/
|
|
265
|
+
iat: number;
|
|
266
|
+
/**
|
|
267
|
+
* @hidden
|
|
268
|
+
* Identifies the security token service (STS) that constructs and returns the token. In the tokens that Microsoft Entra
|
|
269
|
+
* returns, the issuer is sts.windows.net. The GUID in the issuer claim value is the tenant ID of the Microsoft Entra
|
|
270
|
+
* directory. The tenant ID is an immutable and reliable identifier of the directory.
|
|
271
|
+
*
|
|
272
|
+
* @internal
|
|
273
|
+
* Limited to Microsoft-internal use
|
|
274
|
+
*/
|
|
275
|
+
iss: string;
|
|
276
|
+
/**
|
|
277
|
+
* @hidden
|
|
278
|
+
* Provides the last name, surname, or family name of the user as defined in the Microsoft Entra user object.
|
|
279
|
+
*
|
|
280
|
+
* @internal
|
|
281
|
+
* Limited to Microsoft-internal use
|
|
282
|
+
*/
|
|
283
|
+
family_name: string;
|
|
284
|
+
/**
|
|
285
|
+
* @hidden
|
|
286
|
+
* Provides the first or "given" name of the user, as set on the Microsoft Entra user object.
|
|
287
|
+
*
|
|
288
|
+
* @internal
|
|
289
|
+
* Limited to Microsoft-internal use
|
|
290
|
+
*/
|
|
291
|
+
given_name: string;
|
|
292
|
+
/**
|
|
293
|
+
* @hidden
|
|
294
|
+
* Provides a human-readable value that identifies the subject of the token. This value is not guaranteed to
|
|
295
|
+
* be unique within a tenant and is designed to be used only for display purposes.
|
|
296
|
+
*
|
|
297
|
+
* @internal
|
|
298
|
+
* Limited to Microsoft-internal use
|
|
299
|
+
*/
|
|
300
|
+
unique_name: string;
|
|
301
|
+
/**
|
|
302
|
+
* @hidden
|
|
303
|
+
* Contains a unique identifier of an object in Microsoft Entra. This value is immutable and cannot be reassigned or
|
|
304
|
+
* reused. Use the object ID to identify an object in queries to Microsoft Entra.
|
|
305
|
+
*
|
|
306
|
+
* @internal
|
|
307
|
+
* Limited to Microsoft-internal use
|
|
308
|
+
*/
|
|
309
|
+
oid: string;
|
|
310
|
+
/**
|
|
311
|
+
* @hidden
|
|
312
|
+
* Identifies the principal about which the token asserts information, such as the user of an application.
|
|
313
|
+
* This value is immutable and cannot be reassigned or reused, so it can be used to perform authorization
|
|
314
|
+
* checks safely. Because the subject is always present in the tokens the Microsoft Entra issues, we recommended
|
|
315
|
+
* using this value in a general-purpose authorization system.
|
|
316
|
+
*
|
|
317
|
+
* @internal
|
|
318
|
+
* Limited to Microsoft-internal use
|
|
319
|
+
*/
|
|
320
|
+
sub: string;
|
|
321
|
+
/**
|
|
322
|
+
* @hidden
|
|
323
|
+
* An immutable, non-reusable identifier that identifies the directory tenant that issued the token. You can
|
|
324
|
+
* use this value to access tenant-specific directory resources in a multitenant application. For example,
|
|
325
|
+
* you can use this value to identify the tenant in a call to the Graph API.
|
|
326
|
+
*
|
|
327
|
+
* @internal
|
|
328
|
+
* Limited to Microsoft-internal use
|
|
329
|
+
*/
|
|
330
|
+
tid: string;
|
|
331
|
+
/**
|
|
332
|
+
* @hidden
|
|
333
|
+
* Defines the end of the time interval within which a token is valid. The service that validates the token
|
|
334
|
+
* should verify that the current date is within the token lifetime; otherwise it should reject the token. The
|
|
335
|
+
* service might allow for up to five minutes beyond the token lifetime to account for any differences in clock
|
|
336
|
+
* time ("time skew") between Microsoft Entra and the service.
|
|
337
|
+
*
|
|
338
|
+
* @internal
|
|
339
|
+
* Limited to Microsoft-internal use
|
|
340
|
+
*/
|
|
341
|
+
exp: number;
|
|
342
|
+
/**
|
|
343
|
+
* @hidden
|
|
344
|
+
* Defines the start of the time interval within which a token is valid. The service that validates the token
|
|
345
|
+
* should verify that the current date is within the token lifetime; otherwise it should reject the token. The
|
|
346
|
+
* service might allow for up to five minutes beyond the token lifetime to account for any differences in clock
|
|
347
|
+
* time ("time skew") between Microsoft Entra and the service.
|
|
348
|
+
*
|
|
349
|
+
* @internal
|
|
350
|
+
* Limited to Microsoft-internal use
|
|
351
|
+
*/
|
|
352
|
+
nbf: number;
|
|
353
|
+
/**
|
|
354
|
+
* @hidden
|
|
355
|
+
* Stores the user name of the user principal.
|
|
356
|
+
*
|
|
357
|
+
* @internal
|
|
358
|
+
* Limited to Microsoft-internal use
|
|
359
|
+
*/
|
|
360
|
+
upn: string;
|
|
361
|
+
/**
|
|
362
|
+
* @hidden
|
|
363
|
+
* Stores the version number of the token.
|
|
364
|
+
*
|
|
365
|
+
* @internal
|
|
366
|
+
* Limited to Microsoft-internal use
|
|
367
|
+
*/
|
|
368
|
+
ver: string;
|
|
369
|
+
/**
|
|
370
|
+
* @hidden
|
|
371
|
+
* Stores the data residency of the user.
|
|
372
|
+
*
|
|
373
|
+
* @internal
|
|
374
|
+
* Limited to Microsoft-internal use
|
|
375
|
+
*/
|
|
376
|
+
dataResidency?: DataResidency;
|
|
377
|
+
}
|
|
378
|
+
/**
|
|
379
|
+
* @hidden
|
|
380
|
+
* Limited set of data residencies information exposed to 1P application developers
|
|
381
|
+
*
|
|
382
|
+
* @internal
|
|
383
|
+
* Limited to Microsoft-internal use
|
|
384
|
+
*/
|
|
385
|
+
export declare enum DataResidency {
|
|
386
|
+
/**
|
|
387
|
+
* Public
|
|
388
|
+
*/
|
|
389
|
+
Public = "public",
|
|
390
|
+
/**
|
|
391
|
+
* European Union Data Boundary
|
|
392
|
+
*/
|
|
393
|
+
EUDB = "eudb",
|
|
394
|
+
/**
|
|
395
|
+
* Other, stored to cover fields that will not be exposed
|
|
396
|
+
*/
|
|
397
|
+
Other = "other"
|
|
398
|
+
}
|
|
399
|
+
/**
|
|
400
|
+
* @deprecated
|
|
401
|
+
* As of TeamsJS v2.0.0, this interface has been deprecated in favor of a Promise-based pattern.
|
|
402
|
+
* @hidden
|
|
403
|
+
* Describes the UserRequest. Success callback describes how a successful request is handled.
|
|
404
|
+
* Failure callback describes how a failed request is handled.
|
|
405
|
+
* @internal
|
|
406
|
+
* Limited to Microsoft-internal use
|
|
407
|
+
*/
|
|
408
|
+
export interface UserRequest {
|
|
409
|
+
/**
|
|
410
|
+
* A function that is called if the token request succeeds, with the resulting token.
|
|
411
|
+
*/
|
|
412
|
+
successCallback?: (user: UserProfile) => void;
|
|
413
|
+
/**
|
|
414
|
+
* A function that is called if the token request fails, with the reason for the failure.
|
|
415
|
+
*/
|
|
416
|
+
failureCallback?: (reason: string) => void;
|
|
417
|
+
}
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Module for managing the app icon badge count.
|
|
3
|
+
*
|
|
4
|
+
* Controls the numeric badge displayed on the app icon in the device's home screen
|
|
5
|
+
* or app launcher. Useful for showing unread counts, pending items, etc.
|
|
6
|
+
*
|
|
7
|
+
* @module
|
|
8
|
+
*/
|
|
9
|
+
/**
|
|
10
|
+
* Sets the app icon badge count.
|
|
11
|
+
*
|
|
12
|
+
* @param count - The number to display on the badge. Must be >= 0.
|
|
13
|
+
* Setting to 0 clears the badge.
|
|
14
|
+
* @returns A Promise that resolves when the badge is updated.
|
|
15
|
+
* @throws Error if the capability is not supported.
|
|
16
|
+
*
|
|
17
|
+
* @example
|
|
18
|
+
* ```typescript
|
|
19
|
+
* // Show 3 unread messages
|
|
20
|
+
* await badge.setCount(3);
|
|
21
|
+
*
|
|
22
|
+
* // Clear the badge
|
|
23
|
+
* await badge.setCount(0);
|
|
24
|
+
* ```
|
|
25
|
+
*/
|
|
26
|
+
export declare function setCount(count: number): Promise<void>;
|
|
27
|
+
/**
|
|
28
|
+
* Clears the app icon badge (sets count to 0).
|
|
29
|
+
*
|
|
30
|
+
* @returns A Promise that resolves when the badge is cleared.
|
|
31
|
+
* @throws Error if the capability is not supported.
|
|
32
|
+
*
|
|
33
|
+
* @example
|
|
34
|
+
* ```typescript
|
|
35
|
+
* await badge.clear();
|
|
36
|
+
* ```
|
|
37
|
+
*/
|
|
38
|
+
export declare function clear(): Promise<void>;
|
|
39
|
+
/**
|
|
40
|
+
* Checks if the badge capability is supported by the host.
|
|
41
|
+
*/
|
|
42
|
+
export declare function isSupported(): boolean;
|