@types/office-js-preview 1.0.491 → 1.0.493

office-js-preview/README.md

@@ -8,7 +8,7 @@ This package contains type definitions for office-js-preview (https://github.com
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview.
 
 ### Additional Details
- * Last updated: Tue, 06 Aug 2024 17:36:11 GMT
+ * Last updated: Tue, 06 Aug 2024 21:07:20 GMT
  * Dependencies: none
 
 # Credits

office-js-preview/index.d.ts

@@ -3508,7 +3508,7 @@ declare namespace Office {
         value: T;
     }
     /**
-     * The Office Auth namespace, `Office.auth`, provides a method that allows the Office client application to obtain an access token to the add-in's web application.
+     * The Office Auth namespace, `Office.auth`, provides methods for the Office client application to obtain access tokens to the add-in's web application.
      * Indirectly, this also enables the add-in to access the signed-in user's Microsoft Graph data without requiring the user to sign in a second time.
      */
     interface Auth {
@@ -3594,6 +3594,18 @@ declare namespace Office {
          * @returns Promise to the access token.
          */
         getAccessToken(options?: AuthOptions): Promise<string>;
+        /**
+         * Get the necessary information about the current user. The add-in passes this to MSAL.js to get an access token for the current session.
+         *
+         * @remarks
+         *
+         * **Hosts**: Excel, OneNote, Outlook, PowerPoint, Word
+         * 
+         * **Requirement set**: NestedAppAuth 1.1
+         * 
+         * @returns Promise to the AuthContext object.
+         */
+        getAuthContext(): Promise<AuthContext>;
     }
     /**
      * Provides options for the user experience when Office obtains an access token to the add-in from AAD v. 2.0 with the `getAccessToken` method.
@@ -3654,6 +3666,35 @@ declare namespace Office {
          */
         forMSGraphAccess?: boolean;
     }
+    /**
+     * Represents the user information which can be passed to msal.js.
+     */
+    interface AuthContext {
+        /**
+         * The unique ID of the account.
+         */
+        userObjectId: string;
+        /**
+         * The full tenant or organizational ID that this account belongs to.
+         */
+        tenantId: string;
+        /**
+         * The user's internet-style login name, based on the Internet standard RFC. Also known as UPN. 
+         */
+        userPrincipalName: string;
+        /**
+         * The identity type by its identity provider (IdP) for this account. "aad" represents an organization account and "msa" represents a {@link https://support.microsoft.com/account-billing/4a7c48e9-ff5a-e9c6-5a5c-1a57d66c3bfa | Microsoft personal account}.
+         */
+        authorityType: "aad" | "msa" | "other";
+        /**
+         * The URL that indicates a directory that MSAL can request tokens from.
+         */
+        authorityBaseUrl: string;
+        /**
+         * An optional claim that provides a hint about the user account attempting to sign in.
+         */
+        loginHint: string;
+    }
     /**
      * Represents a modal notification dialog that can appear when the user attempts to close a document. The document won't close until the user responds.
      * The notification dialog will allow the user to confirm the request to close the document or cancel the request to close the document.
@@ -91740,7 +91781,7 @@ declare namespace Word {
         /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
         context: RequestContext;
         /**
-         * Specifies the checkbox-related data if the content control's type is 'CheckBox'. It's null otherwise.
+         * Specifies the checkbox-related data if the content control's type is 'CheckBox'. It's `null` otherwise.
          *
          * @remarks
          * [Api set: WordApi 1.7]
@@ -91762,7 +91803,7 @@ declare namespace Word {
          */
         readonly contentControls: Word.ContentControlCollection;
         /**
-         * Specifies the dropdown list-related data if the content control's type is 'DropDownList'. It's null otherwise.
+         * Specifies the dropdown list-related data if the content control's type is 'DropDownList'. It's `null` otherwise.
          *
          * @remarks
          * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -92646,8 +92687,8 @@ declare namespace Word {
          * @remarks
          * [Api set: WordApi 1.5]
          *
-         * Note: `PlainText` support was added in WordApi 1.5. `CheckBox` support was added in WordApi 1.7.
-         * `DropDownList` and `ComboBox` support are currently in preview.
+         * Note: 'PlainText' support was added in WordApi 1.5. 'CheckBox' support was added in WordApi 1.7.
+         * 'DropDownList' and 'ComboBox' support are currently in preview.
          */
         types: Word.ContentControlType[];
     }
@@ -94184,7 +94225,11 @@ 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}.
+     * 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. */
@@ -94255,7 +94300,7 @@ declare namespace Word {
          */
         code: string;
         /**
-         * Specifies data in an "Addin" field. If the field isn't an "Addin" field, it is null and it will throw a general exception when code attempts to set it.
+         * Specifies data in an "Addin" field. If the field isn't an "Addin" field, it is `null` and it will throw a general exception when code attempts to set it.
          *
          * @remarks
          * [Api set: WordApi 1.5]
@@ -94385,7 +94430,11 @@ 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}.
+     * 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. */
@@ -94486,7 +94535,7 @@ declare namespace Word {
          */
         hidden: boolean;
         /**
-         * Specifies the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or null for no highlight color. Note: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font.
+         * Specifies the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or `null` for no highlight color. Note: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font.
          *
          * @remarks
          * [Api set: WordApi 1.1]
@@ -97029,17 +97078,17 @@ declare namespace Word {
          *
          * 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 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.addin`
          *
-         * - Word.FieldType.date
+         * - `Word.FieldType.date`
          *
-         * - Word.FieldType.hyperlink
+         * - `Word.FieldType.hyperlink`
          *
-         * - Word.FieldType.toc
+         * - `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.
@@ -97055,17 +97104,17 @@ declare namespace Word {
          *
          * 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 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.addin`
          *
-         * - Word.FieldType.date
+         * - `Word.FieldType.date`
          *
-         * - Word.FieldType.hyperlink
+         * - `Word.FieldType.hyperlink`
          *
-         * - Word.FieldType.toc
+         * - `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.
@@ -104096,7 +104145,7 @@ declare namespace Word {
         /** An interface for updating data on the `ContentControl` object, for use in `contentControl.set({ ... })`. */
         interface ContentControlUpdateData {
             /**
-             * Specifies the checkbox-related data if the content control's type is 'CheckBox'. It's null otherwise.
+             * Specifies the checkbox-related data if the content control's type is 'CheckBox'. It's `null` otherwise.
              *
              * @remarks
              * [Api set: WordApi 1.7]
@@ -104365,7 +104414,7 @@ declare namespace Word {
              */
             code?: string;
             /**
-             * Specifies data in an "Addin" field. If the field isn't an "Addin" field, it is null and it will throw a general exception when code attempts to set it.
+             * Specifies data in an "Addin" field. If the field isn't an "Addin" field, it is `null` and it will throw a general exception when code attempts to set it.
              *
              * @remarks
              * [Api set: WordApi 1.5]
@@ -104423,7 +104472,7 @@ declare namespace Word {
              */
             hidden?: boolean;
             /**
-             * Specifies the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or null for no highlight color. Note: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font.
+             * Specifies the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or `null` for no highlight color. Note: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font.
              *
              * @remarks
              * [Api set: WordApi 1.1]
@@ -105756,14 +105805,14 @@ declare namespace Word {
         /** An interface describing the data returned by calling `contentControl.toJSON()`. */
         interface ContentControlData {
             /**
-             * Specifies the checkbox-related data if the content control's type is 'CheckBox'. It's null otherwise.
+             * Specifies the checkbox-related data if the content control's type is 'CheckBox'. It's `null` otherwise.
              *
              * @remarks
              * [Api set: WordApi 1.7]
              */
             checkboxContentControl?: Word.Interfaces.CheckboxContentControlData;
             /**
-             * Specifies the combo box-related data if the content control's type is 'ComboBox'. It's null otherwise.
+             * Specifies the combo box-related data if the content control's type is 'ComboBox'. It's `null` otherwise.
              *
              * @remarks
              * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -105778,7 +105827,7 @@ declare namespace Word {
              */
             contentControls?: Word.Interfaces.ContentControlData[];
             /**
-             * Specifies the dropdown list-related data if the content control's type is 'DropDownList'. It's null otherwise.
+             * Specifies the dropdown list-related data if the content control's type is 'DropDownList'. It's `null` otherwise.
              *
              * @remarks
              * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -106283,7 +106332,7 @@ declare namespace Word {
              */
             code?: string;
             /**
-             * Specifies data in an "Addin" field. If the field isn't an "Addin" field, it is null and it will throw a general exception when code attempts to set it.
+             * Specifies data in an "Addin" field. If the field isn't an "Addin" field, it is `null` and it will throw a general exception when code attempts to set it.
              *
              * @remarks
              * [Api set: WordApi 1.5]
@@ -106355,7 +106404,7 @@ declare namespace Word {
              */
             hidden?: boolean;
             /**
-             * Specifies the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or null for no highlight color. Note: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font.
+             * Specifies the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or `null` for no highlight color. Note: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font.
              *
              * @remarks
              * [Api set: WordApi 1.1]
@@ -108289,7 +108338,7 @@ declare namespace Word {
              */
             $all?: boolean;
             /**
-             * Specifies the checkbox-related data if the content control's type is 'CheckBox'. It's null otherwise.
+             * Specifies the checkbox-related data if the content control's type is 'CheckBox'. It's `null` otherwise.
              *
              * @remarks
              * [Api set: WordApi 1.7]
@@ -108464,7 +108513,7 @@ declare namespace Word {
              */
             $all?: boolean;
             /**
-             * For EACH ITEM in the collection: Specifies the checkbox-related data if the content control's type is 'CheckBox'. It's null otherwise.
+             * For EACH ITEM in the collection: Specifies the checkbox-related data if the content control's type is 'CheckBox'. It's `null` otherwise.
              *
              * @remarks
              * [Api set: WordApi 1.7]
@@ -109054,6 +109103,12 @@ 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}.
          */
         interface FieldLoadOptions {
             /**
@@ -109126,7 +109181,7 @@ declare namespace Word {
              */
             code?: boolean;
             /**
-             * Specifies data in an "Addin" field. If the field isn't an "Addin" field, it is null and it will throw a general exception when code attempts to set it.
+             * Specifies data in an "Addin" field. If the field isn't an "Addin" field, it is `null` and it will throw a general exception when code attempts to set it.
              *
              * @remarks
              * [Api set: WordApi 1.5]
@@ -109167,6 +109222,12 @@ 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}.
          */
         interface FieldCollectionLoadOptions {
             /**
@@ -109239,7 +109300,7 @@ declare namespace Word {
              */
             code?: boolean;
             /**
-             * For EACH ITEM in the collection: Specifies data in an "Addin" field. If the field isn't an "Addin" field, it is null and it will throw a general exception when code attempts to set it.
+             * For EACH ITEM in the collection: Specifies data in an "Addin" field. If the field isn't an "Addin" field, it is `null` and it will throw a general exception when code attempts to set it.
              *
              * @remarks
              * [Api set: WordApi 1.5]
@@ -109316,7 +109377,7 @@ declare namespace Word {
              */
             hidden?: boolean;
             /**
-             * Specifies the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or null for no highlight color. Note: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font.
+             * Specifies the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or `null` for no highlight color. Note: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font.
              *
              * @remarks
              * [Api set: WordApi 1.1]

office-js-preview/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/office-js-preview",
-    "version": "1.0.491",
+    "version": "1.0.493",
     "description": "TypeScript definitions for office-js-preview",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
     "license": "MIT",
@@ -45,7 +45,7 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "cb6c4af002a2cccabb7dd32d8940b20a3a0c76bc06e5bf94e0748130998c5a88",
+    "typesPublisherContentHash": "4191dd40aebad27509c7f37fda2a5e0e9ec22c57918a6783e5afd810e1dd4d8b",
     "typeScriptVersion": "4.8",
     "nonNpm": true
 }