@types/office-js 1.0.349 → 1.0.351

office-js/README.md

@@ -2,15 +2,14 @@
 > `npm install --save @types/office-js`
 
 # Summary
-This package contains type definitions for Office.js (https://github.com/OfficeDev/office-js).
+This package contains type definitions for office-js (https://github.com/OfficeDev/office-js).
 
 # Details
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js.
 
 ### Additional Details
- * Last updated: Fri, 06 Oct 2023 19:35:19 GMT
+ * Last updated: Wed, 18 Oct 2023 05:47:08 GMT
  * Dependencies: none
- * Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
 
 # Credits
 These definitions were written by [OfficeDev](https://github.com/OfficeDev), [Ricky Kirkham](https://github.com/Rick-Kirkham), [Alex Jerabek](https://github.com/AlexJerabek), [Elizabeth Samuel](https://github.com/ElizabethSamuel-MSFT), [Alison McKay](https://github.com/alison-mk), and [Sam Ramon](https://github.com/samantharamon).

office-js/index.d.ts

@@ -1,14 +1,3 @@
-// Type definitions for Office.js 1.0
-// Project: https://github.com/OfficeDev/office-js
-// Definitions by: OfficeDev <https://github.com/OfficeDev>,
-//                 Ricky Kirkham <https://github.com/Rick-Kirkham>,
-//                 Alex Jerabek <https://github.com/AlexJerabek>,
-//                 Elizabeth Samuel <https://github.com/ElizabethSamuel-MSFT>,
-//                 Alison McKay <https://github.com/alison-mk>,
-//                 Sam Ramon <https://github.com/samantharamon>
-// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.4
-
 /*
 office-js
 Copyright (c) Microsoft Corporation
@@ -14110,10 +14099,7 @@ declare namespace Office {
          */
         addHandlerAsync(eventType: Office.EventType | string, handler: any, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
         /**
-         * Converts an item ID formatted for REST into EWS format.
-         *
-         * Item IDs retrieved via a REST API (such as the Outlook Mail API or the Microsoft Graph) use a different format than the format used by
-         * Exchange Web Services (EWS). The `convertToEwsId` method converts a REST-formatted ID into the proper format for EWS.
+         * Converts a supported ID into the Exchange Web Services (EWS) format.
          *
          * @remarks
          * [Api set: Mailbox 1.3]
@@ -14122,13 +14108,19 @@ declare namespace Office {
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
          *
-         * **Important**: This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
+         * **Important**:
+         *
+         * - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
          * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
          *
-         * @param itemId - An item ID formatted for the Outlook REST APIs.
+         * - Item IDs retrieved via a REST API (such as the Outlook Mail API or the Microsoft Graph) use a different format than the format used by EWS.
+         * The `convertToEwsId` method converts a REST-formatted ID into the proper format for EWS.
+         *
+         * @param id - The ID to be converted into EWS format. This string can be an item ID formatted for the Outlook REST APIs or a conversation ID retrieved from
+         *             `Office.context.mailbox.item.conversationId`.
          * @param restVersion - A value indicating the version of the Outlook REST API used to retrieve the item ID.
          */
-        convertToEwsId(itemId: string, restVersion: MailboxEnums.RestVersion | string): string;
+        convertToEwsId(id: string, restVersion: MailboxEnums.RestVersion | string): string;
         /**
          * Gets a dictionary containing time information in local client time.
          *
@@ -14152,7 +14144,7 @@ declare namespace Office {
          */
         convertToLocalClientTime(timeValue: Date): LocalClientTime;
         /**
-         * Converts an item ID formatted for EWS into REST format.
+         * Converts a supported ID into REST format.
          *
          * @remarks
          * [Api set: Mailbox 1.3]
@@ -14166,15 +14158,17 @@ declare namespace Office {
          * - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
          * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
          *
-         * - Item IDs retrieved via EWS or via the `itemId` property use a different format than the format used by REST APIs (such as the
+         * - Item IDs retrieved via Exchange Web Services (EWS) or via the `itemId` property use a different format than the format used by REST APIs (such as the
          * {@link https://learn.microsoft.com/previous-versions/office/office-365-api/api/version-2.0/mail-rest-operations | Outlook Mail API}
-         * or the {@link https://graph.microsoft.io/ | Microsoft Graph}.
+         * or the {@link https://graph.microsoft.io/ | Microsoft Graph}).
          * The `convertToRestId` method converts an EWS-formatted ID into the proper format for REST.
          *
-         * @param itemId - An item ID formatted for Exchange Web Services (EWS)
-         * @param restVersion - A value indicating the version of the Outlook REST API that the converted ID will be used with.
+         * @param id - The ID to be converted into REST format. This string can be an item ID formatted for EWS that's usually retrieved from
+         *             `Office.context.mailbox.item.itemId`, a conversation ID retrieved from `Office.context.mailbox.item.conversationId`, or a
+         *             series ID retrieved from `Office.context.mailbox.item.seriesId`.
+         * @param restVersion - A value indicating the version of the Outlook REST API used with the converted ID.
          */
-        convertToRestId(itemId: string, restVersion: MailboxEnums.RestVersion | string): string;
+        convertToRestId(id: string, restVersion: MailboxEnums.RestVersion | string): string;
         /**
          * Gets a `Date` object from a dictionary containing time information.
          *

office-js/package.json

@@ -1,39 +1,39 @@
 {
     "name": "@types/office-js",
-    "version": "1.0.349",
-    "description": "TypeScript definitions for Office.js",
+    "version": "1.0.351",
+    "description": "TypeScript definitions for office-js",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js",
     "license": "MIT",
     "contributors": [
         {
             "name": "OfficeDev",
-            "url": "https://github.com/OfficeDev",
-            "githubUsername": "OfficeDev"
+            "githubUsername": "OfficeDev",
+            "url": "https://github.com/OfficeDev"
         },
         {
             "name": "Ricky Kirkham",
-            "url": "https://github.com/Rick-Kirkham",
-            "githubUsername": "Rick-Kirkham"
+            "githubUsername": "Rick-Kirkham",
+            "url": "https://github.com/Rick-Kirkham"
         },
         {
             "name": "Alex Jerabek",
-            "url": "https://github.com/AlexJerabek",
-            "githubUsername": "AlexJerabek"
+            "githubUsername": "AlexJerabek",
+            "url": "https://github.com/AlexJerabek"
         },
         {
             "name": "Elizabeth Samuel",
-            "url": "https://github.com/ElizabethSamuel-MSFT",
-            "githubUsername": "ElizabethSamuel-MSFT"
+            "githubUsername": "ElizabethSamuel-MSFT",
+            "url": "https://github.com/ElizabethSamuel-MSFT"
         },
         {
             "name": "Alison McKay",
-            "url": "https://github.com/alison-mk",
-            "githubUsername": "alison-mk"
+            "githubUsername": "alison-mk",
+            "url": "https://github.com/alison-mk"
         },
         {
             "name": "Sam Ramon",
-            "url": "https://github.com/samantharamon",
-            "githubUsername": "samantharamon"
+            "githubUsername": "samantharamon",
+            "url": "https://github.com/samantharamon"
         }
     ],
     "main": "",
@@ -45,6 +45,6 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "17c7eafb0c249980c06196b73d160a493e31c2c8b5e5009ee334f07b399fa986",
+    "typesPublisherContentHash": "18995246a22f0e1be416e9adebccd26a03cca77ec7e5d05f8b52fba53692d8c9",
     "typeScriptVersion": "4.5"
 }