@types/office-js-preview 1.0.315 → 1.0.318

office-js-preview/README.md

@@ -8,7 +8,7 @@ This package contains type definitions for Office.js (https://github.com/OfficeD
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview.
 
 ### Additional Details
- * Last updated: Thu, 16 Jun 2022 20:31:36 GMT
+ * Last updated: Fri, 08 Jul 2022 00:32:15 GMT
  * Dependencies: none
  * Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
 

office-js-preview/index.d.ts

@@ -1536,9 +1536,15 @@ declare namespace Office {
          *
          * **Hosts**: Excel, OneNote, Outlook, PowerPoint, Word
          * 
-         * **Important**: In Outlook, this API is not supported if the add-in is loaded in an Outlook.com or Gmail mailbox. 
-         *
          * **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/identity-api-requirement-sets | IdentityAPI 1.3}
+         * 
+         * **Important**: In Outlook, this API isn't supported if the add-in is loaded in an Outlook.com or Gmail mailbox.
+         * 
+         * **Note**: In an Outlook event-based activation add-in, this API is supported in Outlook on Windows starting from version 2111 (build 14701.20000).
+         * To retrieve an access token in older builds, use 
+         * {@link https://docs.microsoft.com/javascript/api/office-runtime/officeruntime.auth?view=common-js-preview#office-runtime-officeruntime-auth-getaccesstoken-member(1) | 
+         * OfficeRuntime.auth.getAccessToken} instead. For more information, see 
+         * {@link https://docs.microsoft.com/office/dev/add-ins/outlook/use-sso-in-event-based-activation | Enable single sign-on (SSO) in Outlook add-ins that use event-based activation}.
          *
          * @param options - Optional. Accepts an `AuthOptions` object to define sign-on behaviors.
          * @returns Promise to the access token.
@@ -17508,17 +17514,30 @@ declare namespace Office {
          *
          * - New Mac UI, Android: No limit
          *
-         * **Important**: In Outlook on the web, if a user created a new message by activating a contact's email address link from their contact or
-         * profile card, your add-in's `getAsync` call currently won't return a value in the `displayName` property of the
-         * associated `EmailAddressDetails` object. For more details, refer to the
-         * {@link https://github.com/OfficeDev/office-js/issues/2201 | related GitHub issue}.
-         *
          * @remarks
          * [Api set: Mailbox 1.1]
          *
          * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem`
          *
          * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
+         * 
+         * **Important**: In Outlook on the web and on Windows, if a user creates a new message by activating a contact's email address link from their contact
+         * or profile card, your add-in's `Recipients.getAsync` call returns the contact's email address in the `displayName` property of the associated
+         * `EmailAddressDetails` object instead of the contact's saved name. For more details, refer to the
+         * {@link https://github.com/OfficeDev/office-js/issues/2201 | related GitHub issue}.
+         * 
+         * **Important**: The `getAsync` method only returns recipients resolved by the Outlook client. A resolved recipient has the following characteristics.
+         * 
+         * - If the recipient has a saved entry in the sender's address book, Outlook resolves the email address to the recipient's saved display name.
+         * 
+         * - A Teams meeting status icon appears before the recipient's name or email address.
+         * 
+         * - A semicolon appears after the recipient's name or email address.
+         * 
+         * - The recipient's name or email address is underlined or enclosed in a box.
+         * 
+         * To resolve an email address once it's added to a mail item, the sender must use the **Tab** key or select a suggested contact or email address from 
+         * the auto-complete list.
          *
          * @param options - An object literal that contains one or more of the following properties.
          *        `asyncContext`: Developers can provide any object they wish to access in the callback method.
@@ -17536,17 +17555,30 @@ declare namespace Office {
          *
          * - New Mac UI, Android: No limit
          *
-         * **Important**: In Outlook on the web, if a user created a new message by activating a contact's email address link from their contact or
-         * profile card, your add-in's `getAsync` call currently won't return a value in the `displayName` property of the
-         * associated `EmailAddressDetails` object. For more details, refer to the
-         * {@link https://github.com/OfficeDev/office-js/issues/2201 | related GitHub issue}.
-         *
          * @remarks
          * [Api set: Mailbox 1.1]
          *
          * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem`
          *
          * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
+         * 
+         * **Important**: In Outlook on the web and on Windows, if a user creates a new message by activating a contact's email address link from their contact
+         * or profile card, your add-in's `Recipients.getAsync` call returns the contact's email address in the `displayName` property of the associated
+         * `EmailAddressDetails` object instead of the contact's saved name. For more details, refer to the
+         * {@link https://github.com/OfficeDev/office-js/issues/2201 | related GitHub issue}.
+         * 
+         * **Important**: The `getAsync` method only returns recipients resolved by the Outlook client. A resolved recipient has the following characteristics.
+         * 
+         * - If the recipient has a saved entry in the sender's address book, Outlook resolves the email address to the recipient's saved display name.
+         * 
+         * - A Teams meeting status icon appears before the recipient's name or email address.
+         * 
+         * - A semicolon appears after the recipient's name or email address.
+         * 
+         * - The recipient's name or email address is underlined or enclosed in a box.
+         * 
+         * To resolve an email address once it's added to a mail item, the sender must use the **Tab** key or select a suggested contact or email address from 
+         * the auto-complete list.
          *
          * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter
          *                 of type `Office.AsyncResult`. The `value` property of the result is an array of `EmailAddressDetails` objects.
@@ -19612,7 +19644,24 @@ declare namespace Excel {
         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
         * @beta
         */
-        lambdaInCell = "LambdaInCell"
+        lambdaInCell = "LambdaInCell",
+        /**
+        * An error caused by a `CellValue` object that is too deeply nested within another `CellValue`. Displays as error type #CALC! in Excel.
+        *
+        * @remarks
+        * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+        * @beta
+        */
+        tooDeeplyNested = "TooDeeplyNested",
+        /**
+        * An error caused by a cell's formula returning a string that exceeds the maximum of 32767 characters. Displays as error type #CALC! in Excel.
+        * Some characters, like emoji, may appear to be one character in the Excel UI but are actually processed as surrogate characters. A surrogate character counts as multiple characters toward the maximum character limit.
+        *
+        * @remarks
+        * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+        * @beta
+        */
+        textOverflow = "TextOverflow"
     }
     /**
     * Represents the value of a cell containing a #CALC! error.
@@ -19663,7 +19712,15 @@ declare namespace Excel {
         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
         * @beta
         */
-        errorSubType?: CalcErrorCellValueSubType | "Unknown" | "ArrayOfArrays" | "ArrayOfRanges" | "EmptyArray" | "UnsupportedLifting" | "DataTableReferencedPendingFormula" | "TooManyCells" | "LambdaInCell";
+        errorSubType?: CalcErrorCellValueSubType | "Unknown" | "ArrayOfArrays" | "ArrayOfRanges" | "EmptyArray" | "UnsupportedLifting" | "DataTableReferencedPendingFormula" | "TooManyCells" | "LambdaInCell" | "TooDeeplyNested" | "TextOverflow";
+        /**
+        * Represents the name of the function causing the error.
+        *
+        * @remarks
+        * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+        * @beta
+        */
+        functionName?: string;
     }
     /**
     * Represents a reference to a property used by the card layout.
@@ -19674,7 +19731,7 @@ declare namespace Excel {
     */
     interface CardLayoutPropertyReference {
         /**
-        * The name of the property referenced by the card layout.
+        * Represents the name of the property referenced by the card layout.
         *
         * @remarks
         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -20806,6 +20863,14 @@ declare namespace Excel {
         */
         div0 = "Div0",
         /**
+        * Represents an `ExternalErrorCellValue`.
+        *
+        * @remarks
+        * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+        * @beta
+        */
+        external = "External",
+        /**
         * Represents a `FieldErrorCellValue`.
         *
         * @remarks
@@ -20893,7 +20958,83 @@ declare namespace Excel {
     * [Api set: ExcelApi BETA (PREVIEW ONLY)]
     * @beta
     */
-    type ErrorCellValue = BlockedErrorCellValue | BusyErrorCellValue | CalcErrorCellValue | ConnectErrorCellValue | Div0ErrorCellValue | FieldErrorCellValue | GettingDataErrorCellValue | NotAvailableErrorCellValue | NameErrorCellValue | NullErrorCellValue | NumErrorCellValue | PlaceholderErrorCellValue | RefErrorCellValue | SpillErrorCellValue | ValueErrorCellValue;
+    type ErrorCellValue = BlockedErrorCellValue | BusyErrorCellValue | CalcErrorCellValue | ConnectErrorCellValue | Div0ErrorCellValue | ExternalErrorCellValue | FieldErrorCellValue | GettingDataErrorCellValue | NotAvailableErrorCellValue | NameErrorCellValue | NullErrorCellValue | NumErrorCellValue | PlaceholderErrorCellValue | RefErrorCellValue | SpillErrorCellValue | ValueErrorCellValue;
+    /**
+    * Represents types of #EXTERNAL! errors.
+    *
+    * @remarks
+    * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+    * @beta
+    */
+    enum ExternalErrorCellValueSubType {
+        /**
+        * An unknown type of error. Displays as error type #EXTERNAL! in Excel.
+        *
+        * @remarks
+        * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+        * @beta
+        */
+        unknown = "Unknown",
+        /**
+        * An error returned by the Python interpreter as a result of running the Python code. Displays as error type #EXTERNAL! in Excel.
+        *
+        * @remarks
+        * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+        * @beta
+        */
+        pythonError = "PythonError"
+    }
+    /**
+    * Represents the value of a cell containing an #EXTERNAL! error.
+    *
+    * @remarks
+    * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+    * @beta
+    */
+    interface ExternalErrorCellValue {
+        /**
+        * Represents the type of this cell value.
+        *
+        * @remarks
+        * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+        * @beta
+        */
+        type: CellValueType.error | "Error";
+        /**
+        * Represents the value that would be returned by `Range.values` for a cell with this value.
+        * When accessed through a `valuesAsJson` property, this string value aligns with the en-US locale.
+        * When accessed through a `valuesAsJsonLocal` property, this string value aligns with the user's display locale.
+        *
+        * @remarks
+        * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+        * @beta
+        */
+        basicValue?: "#EXTERNAL!" | string;
+        /**
+        * Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
+        *
+        * @remarks
+        * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+        * @beta
+        */
+        basicType?: RangeValueType.error | "Error";
+        /**
+        * Represents the type of `ErrorCellValue`.
+        *
+        * @remarks
+        * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+        * @beta
+        */
+        errorType?: ErrorCellValueType.external | "External";
+        /**
+        * Represents the type of `ExternalErrorCellValue`.
+        *
+        * @remarks
+        * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+        * @beta
+        */
+        errorSubType?: ExternalErrorCellValueSubType | "Unknown" | "PythonError";
+    }
     /**
     * Represents types of #FIELD! errors.
     *
@@ -20977,6 +21118,14 @@ declare namespace Excel {
         * @beta
         */
         errorSubType?: FieldErrorCellValueSubType | "Unknown" | "WebImageMissingFilePart" | "DataProviderError";
+        /**
+        * Represents the field which was not found by FIELDVALUE.
+        *
+        * @remarks
+        * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+        * @beta
+        */
+        fieldName?: string;
     }
     /**
     * Represents the value of a cell containing a number with a format string. Number format strings must conform to Excel guidelines. To learn more, see {@link https://support.microsoft.com/office/review-guidelines-for-customizing-a-number-format-c0a1d1fa-d3f4-4018-96b7-9c9354dd99f5  | Review guidelines for customizing a number format}.
@@ -21318,6 +21467,31 @@ declare namespace Excel {
         errorType?: ErrorCellValueType.null | "Null";
     }
     /**
+    * Represents types of #NUM! errors.
+    *
+    * @remarks
+    * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+    * @beta
+    */
+    enum NumErrorCellValueSubType {
+        /**
+        * An unknown type of error. Displays as error type #NUM! in Excel.
+        *
+        * @remarks
+        * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+        * @beta
+        */
+        unknown = "Unknown",
+        /**
+        * An error caused by a cell's formula having an array parameter with too many rows or columns. The maximum number of rows and columns in an array parameter is 1048576. Displays as error type #NUM! in Excel.
+        *
+        * @remarks
+        * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+        * @beta
+        */
+        arrayTooLarge = "ArrayTooLarge"
+    }
+    /**
     * Represents the value of a cell containing a #NUM! error.
     *
     * @remarks
@@ -21359,6 +21533,22 @@ declare namespace Excel {
         * @beta
         */
         errorType?: ErrorCellValueType.num | "Num";
+        /**
+        * Represents the type of `NumErrorCellValue`.
+        *
+        * @remarks
+        * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+        * @beta
+        */
+        errorSubType?: NumErrorCellValueSubType | "Unknown" | "ArrayTooLarge";
+        /**
+        * Represents the name of the function causing the error.
+        *
+        * @remarks
+        * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+        * @beta
+        */
+        functionName?: string;
     }
     /**
     * Represents types of #REF! errors.
@@ -32793,6 +32983,19 @@ declare namespace Excel {
          * @param name Optional. Specifies the name of the new column. If `null`, the default name will be used.
          */
         add(index?: number, values?: Array<Array<boolean | string | number>> | boolean | string | number, name?: string): Excel.TableColumn;
+        /**
+         * Adds a new column to the table.
+                    Unlike `add()`, `addAsJson()` takes any type of cell value, such as image or entity data types.
+         *
+         * @remarks
+         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+         * @beta
+         *
+         * @param index Optional. Specifies the relative position of the new column. If null or -1, the addition happens at the end. Columns with a higher index will be shifted to the side. Zero-indexed.
+         * @param values Optional. A 2D array of cell values of the table column.
+         * @param name Optional. Specifies the name of the new column. If `null`, the default name will be used.
+         */
+        addAsJson(index?: number, values?: CellValue[][], name?: string): Excel.TableColumn;
         /**
          * Gets the number of columns in the table.
          *
@@ -33026,6 +33229,24 @@ declare namespace Excel {
          * @param alwaysInsert Optional. Specifies whether the new rows will be inserted into the table when new rows are added. If `true`, the new rows will be inserted into the table. If `false`, the new rows will be added below the table. Default is `true`.
          */
         add(index?: number, values?: Array<Array<boolean | string | number>> | boolean | string | number, alwaysInsert?: boolean): Excel.TableRow;
+        /**
+         * Adds one or more rows to the table. The returned object will be the top row of the newly added row or rows.
+                     Unlike `add()`, `addAsJson()` takes any type of cell value, such as image or entity data types.
+                    
+                     Note that unlike ranges or columns, which will adjust if new rows or columns are added before them,
+                     a `TableRow` object represents the physical location of the table row, but not the data.
+                     That is, if the data is sorted or if new rows are added, a table row will continue
+                     to point at the index for which it was created.
+         *
+         * @remarks
+         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+         * @beta
+         *
+         * @param index Optional. Specifies the relative position of the new row. If null or -1, the addition happens at the end. Any rows below the inserted row are shifted downwards. Zero-indexed.
+         * @param values Optional. A 2D array of cell values of the table row.
+         * @param alwaysInsert Optional. Specifies whether the new rows will be inserted into the table when new rows are added. If `true`, the new rows will be inserted into the table. If `false`, the new rows will be added below the table. Default is `true`.
+         */
+        addAsJson(index?: number, values?: CellValue[][], alwaysInsert?: boolean): Excel.TableRow;
         /**
          * Delete multiple rows from a table.
                     These rows don't need to be sequential. This method will throw the `InvalidArgument` error if a chosen row has already been deleted or doesn't exist.

office-js-preview/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/office-js-preview",
-    "version": "1.0.315",
+    "version": "1.0.318",
     "description": "TypeScript definitions for Office.js",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
     "license": "MIT",
@@ -45,6 +45,6 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "7b8b6cb450be9b3c52cd71cd1dd00a54a63029abb20462fab4e186809b42c9ba",
+    "typesPublisherContentHash": "bf8642e42365f504fdabe3aa84a7a02ca4d53fc8dd8056c72ed6be5c0d143aeb",
     "typeScriptVersion": "4.0"
 }