@types/office-js-preview 1.0.422 → 1.0.424

office-js-preview/README.md

@@ -2,15 +2,14 @@
 > `npm install --save @types/office-js-preview`
 
 # Summary
-This package contains type definitions for Office.js (https://github.com/OfficeDev/office-js).
+This package contains type definitions for office-js-preview (https://github.com/OfficeDev/office-js).
 
 # Details
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview.
 
 ### 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-preview/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
@@ -14449,10 +14438,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]
@@ -14461,13 +14447,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.
          *
@@ -14491,7 +14483,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]
@@ -14505,15 +14497,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.
          *
@@ -28906,115 +28900,6 @@ declare namespace Excel {
          */
         undo = "undo"
     }
-    /**
-     * Represents a recorded change to the task, to be used as an input parameter.
-     *
-     * @remarks
-     * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-     * @beta
-     */
-    interface DocumentTaskChangeProperties {
-        /**
-         * Represents the user assigned to the task for an `assign` change action, or the user unassigned from the task for an `unassign` change action.
-         *
-         * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-         * @beta
-         */
-        assignee?: Excel.EmailIdentity;
-        /**
-         * Represents the identity of the user who made the task change.
-         *
-         * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-         * @beta
-         */
-        changedBy: Excel.EmailIdentity;
-        /**
-         * Represents the ID of the `comment` or `commentReply` to which the task change is anchored.
-         *
-         * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-         * @beta
-         */
-        commentId?: string;
-        /**
-         * Represents the creation date and time of the task change record. All dates are in UTC.
-         *
-         * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-         * @beta
-         */
-        createdDateTime?: Date;
-        /**
-         * Represents the task's due date and time. It is used for the `setSchedule` change action.
-                    It is in UTC time zone. It can be set to `null` to remove the due date and time. It should be set together with `startDateTime` to avoid conflicts.
-         *
-         * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-         * @beta
-         */
-        dueDateTime?: Date;
-        /**
-         * The unique GUID of the task change.
-         *
-         * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-         * @beta
-         */
-        id: string;
-        /**
-         * Represents the task's completion percentage. It is used for the `setPercentComplete` change action.
-                    This is a value betwen 0 and 100, where 100 represents a completed task. Changing this value to 100 also completes the associated comment. Changing the completion from 100 to a lower value reactivates the associated comment.
-         *
-         * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-         * @beta
-         */
-        percentComplete?: number;
-        /**
-         * Represents the task's priority. It is used for the `setPriority` change action.
-                    This is a value between 0 and 10, with 5 being the default priority if not set, and where 0 represents the highest priority.
-         *
-         * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-         * @beta
-         */
-        priority?: number;
-        /**
-         * Represents the task's start date and time. It is used for the `setSchedule` change action.
-                    It is in UTC time zone. It can be set to `null` to remove the start date and time. It should be set together with `dueDateTime` to avoid conflicts.
-         *
-         * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-         * @beta
-         */
-        startDateTime?: Date;
-        /**
-         * Represents the task's title. It is used for the `setTitle` change action.
-         *
-         * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-         * @beta
-         */
-        title?: string;
-        /**
-         * Represents the action type of the task change record. Some examples of action types are assign, undo, and setPriority.
-         *
-         * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-         * @beta
-         */
-        type: Excel.DocumentTaskChangeAction | "unknown" | "create" | "assign" | "unassign" | "unassignAll" | "setSchedule" | "setPercentComplete" | "setPriority" | "remove" | "restore" | "setTitle" | "undo";
-        /**
-         * Represents the `DocumentTaskChange.id` property that was undone for the `undo` change action.
-         *
-         * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-         * @beta
-         */
-        undoChangeId?: string;
-    }
     /**
      * Represents a recorded change to the task.
      *
@@ -33269,6 +33154,15 @@ declare namespace Excel {
          * [Api set: ExcelApi 1.9]
          */
         chartDataPointTrack: boolean;
+        /**
+         * Specifies the maximum length of time, in seconds, allotted for a formula that depends on an external code service to complete.
+                    The valid range is 1 to 86400, inclusive.
+         *
+         * @remarks
+         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+         * @beta
+         */
+        externalCodeServiceTimeout: number;
         /**
          * Specifies if changes have been made since the workbook was last saved.
                     You can set this property to `true` if you want to close a modified workbook without either saving it or being prompted to save it.
@@ -64857,6 +64751,7 @@ declare namespace Excel {
         openWorkbookLinksBlocked = "OpenWorkbookLinksBlocked",
         operationCellsExceedLimit = "OperationCellsExceedLimit",
         pivotTableRangeConflict = "PivotTableRangeConflict",
+        powerQueryRefreshResourceChallenge = "PowerQueryRefreshResourceChallenge",
         rangeExceedsLimit = "RangeExceedsLimit",
         refreshWorkbookLinksBlocked = "RefreshWorkbookLinksBlocked",
         requestAborted = "RequestAborted",
@@ -65044,6 +64939,15 @@ declare namespace Excel {
              * [Api set: ExcelApi 1.9]
              */
             chartDataPointTrack?: boolean;
+            /**
+             * Specifies the maximum length of time, in seconds, allotted for a formula that depends on an external code service to complete.
+                        The valid range is 1 to 86400, inclusive.
+             *
+             * @remarks
+             * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+             * @beta
+             */
+            externalCodeServiceTimeout?: number;
             /**
              * Specifies if changes have been made since the workbook was last saved.
                         You can set this property to `true` if you want to close a modified workbook without either saving it or being prompted to save it.
@@ -70390,6 +70294,15 @@ declare namespace Excel {
              * [Api set: ExcelApi 1.9]
              */
             chartDataPointTrack?: boolean;
+            /**
+             * Specifies the maximum length of time, in seconds, allotted for a formula that depends on an external code service to complete.
+                        The valid range is 1 to 86400, inclusive.
+             *
+             * @remarks
+             * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+             * @beta
+             */
+            externalCodeServiceTimeout?: number;
             /**
              * Specifies if changes have been made since the workbook was last saved.
                         You can set this property to `true` if you want to close a modified workbook without either saving it or being prompted to save it.
@@ -77674,6 +77587,15 @@ declare namespace Excel {
              * [Api set: ExcelApi 1.9]
              */
             chartDataPointTrack?: boolean;
+            /**
+             * Specifies the maximum length of time, in seconds, allotted for a formula that depends on an external code service to complete.
+                        The valid range is 1 to 86400, inclusive.
+             *
+             * @remarks
+             * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+             * @beta
+             */
+            externalCodeServiceTimeout?: boolean;
             /**
              * Specifies if changes have been made since the workbook was last saved.
                         You can set this property to `true` if you want to close a modified workbook without either saving it or being prompted to save it.

office-js-preview/package.json

@@ -1,39 +1,39 @@
 {
     "name": "@types/office-js-preview",
-    "version": "1.0.422",
-    "description": "TypeScript definitions for Office.js",
+    "version": "1.0.424",
+    "description": "TypeScript definitions for office-js-preview",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
     "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": "8e6a6b3b7eeae372f2cf2e7bfd79f3c619862ee811c72a3783be20254da3a0f0",
+    "typesPublisherContentHash": "d2650a941d06bca35871bec50809bb29cb742aec4189fb84df4a3ebb9b2c9e03",
     "typeScriptVersion": "4.5"
 }