@types/office-js 1.0.350 → 1.0.352

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: Wed, 11 Oct 2023 20:35:12 GMT
+ * Last updated: Thu, 19 Oct 2023 14:43:10 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
@@ -86569,6 +86558,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. */
@@ -86760,6 +86751,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. */
@@ -87879,7 +87872,7 @@ declare namespace Word {
          */
         readonly listItemOrNullObject: Word.ListItem;
         /**
-         * Gets the List to which this paragraph belongs. If the paragraph is not in a list, 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 List to which this paragraph belongs. If the paragraph isn't in a list, 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]
@@ -88956,6 +88949,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.
@@ -88968,6 +88975,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.
@@ -89980,14 +90001,14 @@ declare namespace Word {
          */
         readonly parentTableCell: Word.TableCell;
         /**
-         * Gets the table cell that contains this table. 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 this table. 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.3]
          */
         readonly parentTableCellOrNullObject: Word.TableCell;
         /**
-         * Gets the table that contains this table. 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 this table. 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.3]
@@ -90233,7 +90254,7 @@ declare namespace Word {
          */
         getCell(rowIndex: number, cellIndex: number): Word.TableCell;
         /**
-         * Gets the table cell at a specified row and column. If the specified table cell 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 the table cell at a specified row and column. If the specified table cell 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: WordApi 1.3]
@@ -97412,14 +97433,14 @@ declare namespace Word {
             */
             parentTableCell?: Word.Interfaces.TableCellLoadOptions;
             /**
-            * Gets the table cell that contains the content control. 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 content control. 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.3]
             */
             parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;
             /**
-            * Gets the table that contains the content control. 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 content control. 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.3]
@@ -97578,14 +97599,14 @@ declare namespace Word {
             */
             parentTableCell?: Word.Interfaces.TableCellLoadOptions;
             /**
-            * For EACH ITEM in the collection: Gets the table cell that contains the content control. 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}.
+            * For EACH ITEM in the collection: Gets the table cell that contains the content control. 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.3]
             */
             parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;
             /**
-            * For EACH ITEM in the collection: Gets the table that contains the content control. 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}.
+            * For EACH ITEM in the collection: Gets the table that contains the content control. 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.3]

office-js/package.json

@@ -1,39 +1,39 @@
 {
     "name": "@types/office-js",
-    "version": "1.0.350",
-    "description": "TypeScript definitions for Office.js",
+    "version": "1.0.352",
+    "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": "d0867fb687bc897d20cd15dbfdbbacb60e9d4351bec5e590424888cfe7a72721",
+    "typesPublisherContentHash": "b6e786b24b3da047dbc7f5d4b6abcbd9aa0ceda7fa6e53862fb1ea6889b9983b",
     "typeScriptVersion": "4.5"
 }