@microsoft/teams-js 2.2.1-beta.0 → 2.3.0-beta.0

package/LICENSE

@@ -1,12 +1,12 @@
-Microsoft Teams JS Library
-
-Copyright (c) Microsoft Corporation
-All rights reserved. 
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
+Microsoft Teams JS Library
+
+Copyright (c) Microsoft Corporation
+All rights reserved. 
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
 THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,74 +1,74 @@
-# Microsoft Teams JavaScript client SDK
-
-Welcome to the Teams JavaScript client SDK! For breaking changes, please refer to our [changelog](./CHANGELOG.md) in the current `<root>/packages/teams-js` directory.
-
-This JavaScript library is part of the [Microsoft Teams developer platform](https://docs.microsoft.com/en-us/microsoftteams/platform/). See full [SDK reference documentation](https://docs.microsoft.com/javascript/api/overview/msteams-client?view=msteams-client-js-latest).
-
-## Getting Started
-
-See [instructions](../../README.md#Getting-Started) in the monorepo root for how to clone and build the repository.
-
-Whenever building or testing the Teams client SDK, you can run `yarn build` or `yarn test` from the packages/teams-js directory.
-
-## Installation
-
-To install the stable [version](https://docs.microsoft.com/javascript/api/overview/msteams-client?view=msteams-client-js-latest):
-
-### npm
-
-`npm install --save @microsoft/teams-js`
-
-### yarn
-
-`yarn add @microsoft/teams-js`
-
-### Production
-
-You can reference these files directly [from here](https://res.cdn.office.net/teams-js/2.2.0/js/MicrosoftTeams.min.js) or point your package manager at them.
-
-## Usage
-
-### As a package
-
-Install either using npm or yarn.
-
-**If you are using any dependency loader** such as [RequireJS](http://requirejs.org/) or [SystemJS](https://github.com/systemjs/systemjs) or module bundler such as [browserify](http://browserify.org/), [webpack](https://webpack.github.io/), you can use `import` syntax to import specific modules. For e.g.
-
-```typescript
-import { app } from '@microsoft/teams-js';
-```
-
-### As a script tag
-
-Reference the SDK inside of your `.html` page using:
-
-```html
-<!-- Microsoft Teams JavaScript API (via CDN) -->
-<script
-  src="https://res.cdn.office.net/teams-js/2.2.0/js/MicrosoftTeams.min.js"
-  integrity="sha384-yBjE++eHeBPzIg+IKl9OHFqMbSdrzY2S/LW3qeitc5vqXewEYRWegByWzBN/chRh"
-  crossorigin="anonymous"
-></script>
-
-<!-- Microsoft Teams JavaScript API (via npm) -->
-<script src="node_modules/@microsoft/teams-js@2.2.0/dist/MicrosoftTeams.min.js"></script>
-
-<!-- Microsoft Teams JavaScript API (via local) -->
-<script src="MicrosoftTeams.min.js"></script>
-```
-
-### Dependencies
-
-Teams client SDK depends on [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) type. If you support older browsers and devices which may not yet provide it natively (e.g. IE 11), you need to provide a global polyfill, such as [es6-promise](https://www.npmjs.com/package/es6-promise), in your bundled application. If you're using a script tag to reference the Teams client SDK, you need to make sure the polyfill is included and initialized before the Teams client SDK is.
-
-## Examples
-
-Stay tuned for examples coming soon.
-
-## Testing
-
-The [Teams Test App](https://aka.ms/teams-test-app) is used to validate the Teams client SDK APIs.
-
-## Contributing
-
-Please be sure to check out the [Contributor's guide](../../CONTRIBUTING.md) for crucial steps.
+# Microsoft Teams JavaScript client SDK
+
+Welcome to the Teams JavaScript client SDK! For breaking changes, please refer to our [changelog](./CHANGELOG.md) in the current `<root>/packages/teams-js` directory.
+
+This JavaScript library is part of the [Microsoft Teams developer platform](https://docs.microsoft.com/en-us/microsoftteams/platform/). See full [SDK reference documentation](https://docs.microsoft.com/javascript/api/overview/msteams-client?view=msteams-client-js-latest).
+
+## Getting Started
+
+See [instructions](../../README.md#Getting-Started) in the monorepo root for how to clone and build the repository.
+
+Whenever building or testing the Teams client SDK, you can run `yarn build` or `yarn test` from the packages/teams-js directory.
+
+## Installation
+
+To install the stable [version](https://docs.microsoft.com/javascript/api/overview/msteams-client?view=msteams-client-js-latest):
+
+### npm
+
+`npm install --save @microsoft/teams-js`
+
+### yarn
+
+`yarn add @microsoft/teams-js`
+
+### Production
+
+You can reference these files directly [from here](https://res.cdn.office.net/teams-js/2.2.0/js/MicrosoftTeams.min.js) or point your package manager at them.
+
+## Usage
+
+### As a package
+
+Install either using npm or yarn.
+
+**If you are using any dependency loader** such as [RequireJS](http://requirejs.org/) or [SystemJS](https://github.com/systemjs/systemjs) or module bundler such as [browserify](http://browserify.org/), [webpack](https://webpack.github.io/), you can use `import` syntax to import specific modules. For e.g.
+
+```typescript
+import { app } from '@microsoft/teams-js';
+```
+
+### As a script tag
+
+Reference the SDK inside of your `.html` page using:
+
+```html
+<!-- Microsoft Teams JavaScript API (via CDN) -->
+<script
+  src="https://res.cdn.office.net/teams-js/2.2.0/js/MicrosoftTeams.min.js"
+  integrity="sha384-yBjE++eHeBPzIg+IKl9OHFqMbSdrzY2S/LW3qeitc5vqXewEYRWegByWzBN/chRh"
+  crossorigin="anonymous"
+></script>
+
+<!-- Microsoft Teams JavaScript API (via npm) -->
+<script src="node_modules/@microsoft/teams-js@2.2.0/dist/MicrosoftTeams.min.js"></script>
+
+<!-- Microsoft Teams JavaScript API (via local) -->
+<script src="MicrosoftTeams.min.js"></script>
+```
+
+### Dependencies
+
+Teams client SDK depends on [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) type. If you support older browsers and devices which may not yet provide it natively (e.g. IE 11), you need to provide a global polyfill, such as [es6-promise](https://www.npmjs.com/package/es6-promise), in your bundled application. If you're using a script tag to reference the Teams client SDK, you need to make sure the polyfill is included and initialized before the Teams client SDK is.
+
+## Examples
+
+Stay tuned for examples coming soon.
+
+## Testing
+
+The [Teams Test App](https://aka.ms/teams-test-app) is used to validate the Teams client SDK APIs.
+
+## Contributing
+
+Please be sure to check out the [Contributor's guide](../../CONTRIBUTING.md) for crucial steps.

package/dist/MicrosoftTeams.d.ts

@@ -5886,6 +5886,92 @@ export namespace video {
         function isSupported(): boolean;
 }
 
+/**
+    * Allows your application to interact with the host M365 application's search box.
+    * By integrating your application with the host's search box, users can search
+    * your app using the same search box they use elsewhere in Teams, Outlook, or Office.
+    *
+    * This functionality is in Beta.
+    * @beta
+    */
+export namespace search {
+        /**
+            * This interface contains information pertaining to the contents of the host M365 application's search box
+            *
+            * @beta
+            */
+        interface SearchQuery {
+                /** The current search term in the host search experience */
+                searchTerm: string;
+                /** Timestamp sequence value to ensure messages are processed in correct order / combine them. */
+                timestamp: number;
+        }
+        /**
+            * This type will store the SearchQuery and allow other logic to be made inside the handler.
+            *
+            * @beta
+            */
+        type SearchQueryHandler = (query: SearchQuery) => void;
+        /**
+            * Allows the caller to register for various events fired by the host search experience.
+            * Calling this function indicates that your application intends to plug into the host's search box and handle search events,
+            * when the user is actively using your page/tab.
+            *
+            * The host may visually update its search box, e.g. with the name or icon of your application.
+            *
+            * Your application should *not* re-render inside of these callbacks, there may be a large number
+            * of onChangeHandler calls if the user is typing rapidly in the search box.
+            *
+            * @param onChangeHandler - This optional handler will be called when the user first starts using the
+            * host's search box and as the user types their query. Can be used to put your application into a
+            * word-wheeling state or to display suggestions as the user is typing.
+            *
+            * This handler will be called with an empty {@link SearchQuery.searchTerm} when search is beginning, and subsequently,
+            * with the current contents of the search box.
+            *
+            * @param onClosedHandler - This handler will be called when the user exits or cancels their search.
+            * Should be used to return your application to its most recent, non-search state. The value of {@link SearchQuery.searchTerm}
+            * will be whatever the last query was before ending search.
+            *
+            * @param onExecuteHandler - The handler will be called when the user executes their
+            * search (by pressing Enter for example). Should be used to display the full list of search results.
+            * The value of {@link SearchQuery.searchTerm} is the complete query the user entered in the search box.
+            *
+            * @example
+            * ``` ts
+            * search.registerHandlers(
+                query => {
+                    console.log(`Update your application with the changed search query: ${query.searchTerm}`);
+                },
+                query => {
+                    console.log('Update your application to handle the search experience being closed. Last query: ${query.searchTerm}');
+                },
+                query => {
+                    console.log(`Update your application to handle an executed search result: ${query.searchTerm}`);
+                },
+             );
+            * ```
+            *
+            * @beta
+            */
+        function registerHandlers(onClosedHandler: SearchQueryHandler, onExecuteHandler: SearchQueryHandler, onChangeHandler?: SearchQueryHandler): void;
+        /**
+            * Allows the caller to unregister for all events fired by the host search experience. Calling
+            * this function will cause your app to stop appearing in the set of search scopes in the hosts
+            *
+            * @beta
+            */
+        function unregisterHandlers(): void;
+        /**
+            * Checks if search capability is supported by the host
+            * @returns true if the search capability is supported by the host and false otherwise
+            * false if it is disabled
+            *
+            * @beta
+            */
+        function isSupported(): boolean;
+}
+
 export namespace sharing {
         export const SharingAPIMessages: {
                 shareWebContent: string;

package/dist/MicrosoftTeams.js

@@ -1111,6 +1111,7 @@ __webpack_require__.d(__webpack_exports__, {
   "registerUserSettingsChangeHandler": () => (/* reexport */ registerUserSettingsChangeHandler),
   "remoteCamera": () => (/* reexport */ remoteCamera),
   "returnFocus": () => (/* reexport */ returnFocus),
+  "search": () => (/* reexport */ search),
   "sendCustomEvent": () => (/* reexport */ sendCustomEvent),
   "sendCustomMessage": () => (/* reexport */ sendCustomMessage),
   "setFrameContext": () => (/* reexport */ setFrameContext),
@@ -1127,7 +1128,7 @@ __webpack_require__.d(__webpack_exports__, {
 });
 
 ;// CONCATENATED MODULE: ./src/internal/constants.ts
-var version = "2.2.1-beta.0";
+var version = "2.3.0-beta.0";
 /**
  * @hidden
  * The client version when all SDK APIs started to check platform compatibility for the APIs was 1.6.0.
@@ -2346,6 +2347,7 @@ var runtime = {
         permissions: undefined,
         profile: undefined,
         remoteCamera: undefined,
+        search: undefined,
         sharing: undefined,
         stageView: undefined,
         teams: {
@@ -6883,6 +6885,111 @@ var video;
     video.isSupported = isSupported;
 })(video || (video = {})); //end of video namespace
 
+;// CONCATENATED MODULE: ./src/public/search.ts
+
+
+
+
+
+/**
+ * Allows your application to interact with the host M365 application's search box.
+ * By integrating your application with the host's search box, users can search
+ * your app using the same search box they use elsewhere in Teams, Outlook, or Office.
+ *
+ * This functionality is in Beta.
+ * @beta
+ */
+var search;
+(function (search) {
+    var onChangeHandlerName = 'search.queryChange';
+    var onClosedHandlerName = 'search.queryClose';
+    var onExecutedHandlerName = 'search.queryExecute';
+    /**
+     * Allows the caller to register for various events fired by the host search experience.
+     * Calling this function indicates that your application intends to plug into the host's search box and handle search events,
+     * when the user is actively using your page/tab.
+     *
+     * The host may visually update its search box, e.g. with the name or icon of your application.
+     *
+     * Your application should *not* re-render inside of these callbacks, there may be a large number
+     * of onChangeHandler calls if the user is typing rapidly in the search box.
+     *
+     * @param onChangeHandler - This optional handler will be called when the user first starts using the
+     * host's search box and as the user types their query. Can be used to put your application into a
+     * word-wheeling state or to display suggestions as the user is typing.
+     *
+     * This handler will be called with an empty {@link SearchQuery.searchTerm} when search is beginning, and subsequently,
+     * with the current contents of the search box.
+     *
+     * @param onClosedHandler - This handler will be called when the user exits or cancels their search.
+     * Should be used to return your application to its most recent, non-search state. The value of {@link SearchQuery.searchTerm}
+     * will be whatever the last query was before ending search.
+     *
+     * @param onExecuteHandler - The handler will be called when the user executes their
+     * search (by pressing Enter for example). Should be used to display the full list of search results.
+     * The value of {@link SearchQuery.searchTerm} is the complete query the user entered in the search box.
+     *
+     * @example
+     * ``` ts
+     * search.registerHandlers(
+        query => {
+          console.log(`Update your application with the changed search query: ${query.searchTerm}`);
+        },
+        query => {
+          console.log('Update your application to handle the search experience being closed. Last query: ${query.searchTerm}');
+        },
+        query => {
+          console.log(`Update your application to handle an executed search result: ${query.searchTerm}`);
+        },
+       );
+     * ```
+     *
+     * @beta
+     */
+    function registerHandlers(onClosedHandler, onExecuteHandler, onChangeHandler) {
+        ensureInitialized(FrameContexts.content);
+        if (!isSupported()) {
+            throw errorNotSupportedOnPlatform;
+        }
+        registerHandler(onClosedHandlerName, onClosedHandler);
+        registerHandler(onExecutedHandlerName, onExecuteHandler);
+        if (onChangeHandler) {
+            registerHandler(onChangeHandlerName, onChangeHandler);
+        }
+    }
+    search.registerHandlers = registerHandlers;
+    /**
+     * Allows the caller to unregister for all events fired by the host search experience. Calling
+     * this function will cause your app to stop appearing in the set of search scopes in the hosts
+     *
+     * @beta
+     */
+    function unregisterHandlers() {
+        ensureInitialized(FrameContexts.content);
+        if (!isSupported()) {
+            throw errorNotSupportedOnPlatform;
+        }
+        // This should let the host know to stop making the app scope show up in the search experience
+        // Can also be used to clean up handlers on the host if desired
+        sendMessageToParent('search.unregister');
+        removeHandler(onChangeHandlerName);
+        removeHandler(onClosedHandlerName);
+        removeHandler(onExecutedHandlerName);
+    }
+    search.unregisterHandlers = unregisterHandlers;
+    /**
+     * Checks if search capability is supported by the host
+     * @returns true if the search capability is supported by the host and false otherwise
+     * false if it is disabled
+     *
+     * @beta
+     */
+    function isSupported() {
+        return runtime.supports.search ? true : false;
+    }
+    search.isSupported = isSupported;
+})(search || (search = {}));
+
 ;// CONCATENATED MODULE: ./src/public/sharing.ts
 
 
@@ -7895,6 +8002,7 @@ var tasks;
 
 
 
+