@types/office-js-preview 1.0.423 → 1.0.425

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: Wed, 11 Oct 2023 20:35:13 GMT
+ * Last updated: Thu, 19 Oct 2023 14:43:11 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
@@ -28911,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.
      *
@@ -33274,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.
@@ -64862,6 +64751,7 @@ declare namespace Excel {
         openWorkbookLinksBlocked = "OpenWorkbookLinksBlocked",
         operationCellsExceedLimit = "OperationCellsExceedLimit",
         pivotTableRangeConflict = "PivotTableRangeConflict",
+        powerQueryRefreshResourceChallenge = "PowerQueryRefreshResourceChallenge",
         rangeExceedsLimit = "RangeExceedsLimit",
         refreshWorkbookLinksBlocked = "RefreshWorkbookLinksBlocked",
         requestAborted = "RequestAborted",
@@ -65049,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.
@@ -70395,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.
@@ -77679,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.
@@ -92067,7 +91984,7 @@ declare namespace Word {
          */
         getBookmarkRange(name: string): Word.Range;
         /**
-         * Gets a bookmark's range. If the bookmark does not exist, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
+         * Gets a bookmark's range. If the bookmark doesn't exist, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
          *
          * @remarks
          * [Api set: WordApiHiddenDocument 1.4]
@@ -92356,6 +92273,8 @@ declare namespace Word {
      *
      * @remarks
      * [Api set: WordApi 1.4]
+     *
+     * Important: To learn more about which fields can be inserted, see the Word.Range.insertField API introduced in requirement set 1.5. Support for managing fields is similar to what's available in the Word UI. However, while the Word UI on the web primarily only supports fields as read-only (see {@link https://support.microsoft.com/office/d8f46094-13c3-4966-98c3-259748f3caf1 | Field codes in Word for the web}), the `Addin` field is editable. To learn more about Word UI clients that more fully support fields, see the product list at the beginning of {@link https://support.microsoft.com/office/c429bbb0-8669-48a7-bd24-bab6ba6b06bb | Insert, edit, and view fields in Word}.
      */
     class Field extends OfficeExtension.ClientObject {
         /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -92555,6 +92474,8 @@ declare namespace Word {
      *
      * @remarks
      * [Api set: WordApi 1.4]
+     *
+     * Important: To learn more about which fields can be inserted, see the Word.Range.insertField API introduced in requirement set 1.5. Support for managing fields is similar to what's available in the Word UI. However, while the Word UI on the web primarily only supports fields as read-only (see {@link https://support.microsoft.com/office/d8f46094-13c3-4966-98c3-259748f3caf1 | Field codes in Word for the web}), the `Addin` field is editable. To learn more about Word UI clients that more fully support fields, see the product list at the beginning of {@link https://support.microsoft.com/office/c429bbb0-8669-48a7-bd24-bab6ba6b06bb | Insert, edit, and view fields in Word}.
      */
     class FieldCollection extends OfficeExtension.ClientObject {
         /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -94992,7 +94913,7 @@ declare namespace Word {
          */
         expandTo(range: Word.Range): Word.Range;
         /**
-         * Returns a new range that extends from this range in either direction to cover another range. This range is not changed. If the two ranges do not have a union, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
+         * Returns a new range that extends from this range in either direction to cover another range. This range isn't changed. If the two ranges don't have a union, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
          *
          * @remarks
          * [Api set: WordApi 1.3]
@@ -95172,6 +95093,20 @@ declare namespace Word {
          * @remarks
          * [Api set: WordApi 1.5]
          *
+         * Important:
+         *
+         * In Word on Windows and on Mac, the API supports inserting and managing all types listed in {@link Word.FieldType} except Word.FieldType.others.
+         *
+         * In Word on the web, the API supports inserting and managing the following field types.
+         *
+         * - Word.FieldType.addin
+         *
+         * - Word.FieldType.date
+         *
+         * - Word.FieldType.hyperlink
+         *
+         * - Word.FieldType.toc
+         *
          * @param insertLocation Required. The location relative to the range where the field will be inserted. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
          * @param fieldType Optional. Can be any FieldType constant. The default value is Empty.
          * @param text Optional. Additional properties or options if needed for specified field type.
@@ -95184,6 +95119,20 @@ declare namespace Word {
          * @remarks
          * [Api set: WordApi 1.5]
          *
+         * Important:
+         *
+         * In Word on Windows and on Mac, the API supports inserting and managing all types listed in {@link Word.FieldType} except Word.FieldType.others.
+         *
+         * In Word on the web, the API supports inserting and managing the following field types.
+         *
+         * - Word.FieldType.addin
+         *
+         * - Word.FieldType.date
+         *
+         * - Word.FieldType.hyperlink
+         *
+         * - Word.FieldType.toc
+         *
          * @param insertLocation Required. The location relative to the range where the field will be inserted. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
          * @param fieldType Optional. Can be any FieldType constant. The default value is Empty.
          * @param text Optional. Additional properties or options if needed for specified field type.
@@ -95283,7 +95232,7 @@ declare namespace Word {
          */
         intersectWith(range: Word.Range): Word.Range;
         /**
-         * Returns a new range as the intersection of this range with another range. This range isn't changed. If the two ranges are not overlapped or adjacent, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
+         * Returns a new range as the intersection of this range with another range. This range isn't changed. If the two ranges aren't overlapped or adjacent, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
          *
          * @remarks
          * [Api set: WordApi 1.3]
@@ -107307,14 +107256,14 @@ declare namespace Word {
             */
             parentTableCell?: Word.Interfaces.TableCellLoadOptions;
             /**
-            * Gets the table cell that contains the field. If it is not contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
+            * Gets the table cell that contains the field. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
             *
             * @remarks
             * [Api set: WordApi 1.4]
             */
             parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;
             /**
-            * Gets the table that contains the field. If it is not contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
+            * Gets the table that contains the field. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
             *
             * @remarks
             * [Api set: WordApi 1.4]

office-js-preview/package.json

@@ -1,39 +1,39 @@
 {
     "name": "@types/office-js-preview",
-    "version": "1.0.423",
-    "description": "TypeScript definitions for Office.js",
+    "version": "1.0.425",
+    "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": "6a78737f9139b5d1fb7d6f427c810de9b466a34f4a9bbe9c2862bfbd605ceb2a",
+    "typesPublisherContentHash": "965df4069c607b96b3a93892d32b11b4c21fd69f22aefd0d649d3932429e6289",
     "typeScriptVersion": "4.5"
 }