@types/office-js 1.0.451 → 1.0.452

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
office-js/README.md CHANGED
@@ -8,7 +8,7 @@ This package contains type definitions for office-js (https://github.com/OfficeD
8
8
  Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js.
9
9
 
10
10
  ### Additional Details
11
- * Last updated: Tue, 03 Dec 2024 21:33:41 GMT
11
+ * Last updated: Thu, 12 Dec 2024 21:33:57 GMT
12
12
  * Dependencies: none
13
13
 
14
14
  # Credits
office-js/index.d.ts CHANGED
@@ -15024,12 +15024,11 @@ declare namespace Office {
15024
15024
  *
15025
15025
  * **Important**:
15026
15026
  *
15027
- * - In October 2024, legacy Exchange {@link https://learn.microsoft.com/office/dev/add-ins/outlook/authentication#exchange-user-identity-token | user identity} and
15027
+ * - In February 2025, legacy Exchange {@link https://learn.microsoft.com/office/dev/add-ins/outlook/authentication#exchange-user-identity-token | user identity} and
15028
15028
  * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/authentication#callback-tokens | callback} tokens will be turned off by default for all Exchange Online tenants.
15029
15029
  * This is part of {@link https://blogs.microsoft.com/on-the-issues/2023/11/02/secure-future-initiative-sfi-cybersecurity-cyberattacks/ | Microsoft's Secure Future Initiative},
15030
15030
  * which gives organizations the tools needed to respond to the current threat landscape. Exchange user identity tokens will still work for Exchange on-premises.
15031
- * Nested app authentication is the recommended approach for tokens going forward. For more information, see our {@link https://aka.ms/NAApreviewblog | blog post} and
15032
- * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/faq-nested-app-auth-outlook-legacy-tokens | FAQ page}.
15031
+ * Nested app authentication (NAA) is the recommended approach for tokens going forward. For more information, see the {@link https://aka.ms/naafaq | FAQ page}.
15033
15032
  *
15034
15033
  * - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
15035
15034
  * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
@@ -15541,12 +15540,11 @@ declare namespace Office {
15541
15540
  *
15542
15541
  * **Important**:
15543
15542
  *
15544
- * - In October 2024, legacy Exchange {@link https://learn.microsoft.com/office/dev/add-ins/outlook/authentication#exchange-user-identity-token | user identity} and
15543
+ * - In February 2025, legacy Exchange {@link https://learn.microsoft.com/office/dev/add-ins/outlook/authentication#exchange-user-identity-token | user identity} and
15545
15544
  * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/authentication#callback-tokens | callback} tokens will be turned off by default for all Exchange Online tenants.
15546
15545
  * This is part of {@link https://blogs.microsoft.com/on-the-issues/2023/11/02/secure-future-initiative-sfi-cybersecurity-cyberattacks/ | Microsoft's Secure Future Initiative},
15547
15546
  * which gives organizations the tools needed to respond to the current threat landscape. Exchange user identity tokens will still work for Exchange on-premises.
15548
- * Nested app authentication is the recommended approach for tokens going forward. For more information, see our {@link https://aka.ms/NAApreviewblog | blog post} and
15549
- * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/faq-nested-app-auth-outlook-legacy-tokens | FAQ page}.
15547
+ * Nested app authentication (NAA) is the recommended approach for tokens going forward. For more information, see the {@link https://aka.ms/naafaq | FAQ page}.
15550
15548
  *
15551
15549
  * - The Outlook REST v2.0 and beta endpoints are now deprecated. However, privately released and AppSource-hosted add-ins are able to use the REST service
15552
15550
  * until extended support ends for Outlook 2019 on October 14, 2025. Traffic from these add-ins is automatically identified for exemption. This exemption also
@@ -15606,11 +15604,20 @@ declare namespace Office {
15606
15604
  *
15607
15605
  * **Errors**:
15608
15606
  *
15609
- * - `HTTPRequestFailure`: The request has failed. Please look at the diagnostics object for the HTTP error code.
15607
+ * If your call fails, use the {@link https://learn.microsoft.com/javascript/api/office/office.asyncresult#office-office-asyncresult-diagnostics-member | asyncResult.diagnostics}
15608
+ * property to view details about the error.
15610
15609
  *
15611
- * - `InternalServerError`: The Exchange server returned an error. Please look at the diagnostics object for more information.
15610
+ * - `GenericTokenError: An internal error has occurred.` - In Exchange Online environments, this error occurs when the token can't be retrieved because legacy Exchange tokens
15611
+ * for Outlook add-ins are turned off. We recommend using NAA as a single sign-on solution for your add-in. For guidance on how to implement NAA, see the
15612
+ * {@link https://aka.ms/naafaq | FAQ page}.
15612
15613
  *
15613
- * - `NetworkError`: The user is no longer connected to the network. Please check your network connection and try again.
15614
+ * - `HTTPRequestFailure: The request has failed. Please look at the diagnostics object for the HTTP error code.`
15615
+ *
15616
+ * - `InternalServerError: The Exchange server returned an error. Please look at the diagnostics object for more information.` - In Exchange Online environments,
15617
+ * this error occurs when the token can't be retrieved because legacy Exchange tokens for Outlook add-ins are turned off. We recommend using NAA as a single sign-on solution for your add-in.
15618
+ * For guidance on how to implement NAA, see the {@link https://aka.ms/naafaq | FAQ page}.
15619
+ *
15620
+ * - `NetworkError: The user is no longer connected to the network. Please check your network connection and try again.`
15614
15621
  *
15615
15622
  * @param options - An object literal that contains one or more of the following properties:-
15616
15623
  * `isRest`: Determines if the token provided will be used for the Outlook REST APIs or Exchange Web Services. Default value is `false`.
@@ -15637,12 +15644,11 @@ declare namespace Office {
15637
15644
  *
15638
15645
  * **Important**:
15639
15646
  *
15640
- * - In October 2024, legacy Exchange {@link https://learn.microsoft.com/office/dev/add-ins/outlook/authentication#exchange-user-identity-token | user identity} and
15647
+ * - In February 2025, legacy Exchange {@link https://learn.microsoft.com/office/dev/add-ins/outlook/authentication#exchange-user-identity-token | user identity} and
15641
15648
  * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/authentication#callback-tokens | callback} tokens will be turned off by default for all Exchange Online tenants.
15642
15649
  * This is part of {@link https://blogs.microsoft.com/on-the-issues/2023/11/02/secure-future-initiative-sfi-cybersecurity-cyberattacks/ | Microsoft's Secure Future Initiative},
15643
15650
  * which gives organizations the tools needed to respond to the current threat landscape. Exchange user identity tokens will still work for Exchange on-premises.
15644
- * Nested app authentication is the recommended approach for tokens going forward. For more information, see our {@link https://aka.ms/NAApreviewblog | blog post} and
15645
- * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/faq-nested-app-auth-outlook-legacy-tokens | FAQ page}.
15651
+ * Nested app authentication (NAA) is the recommended approach for tokens going forward. For more information, see the {@link https://aka.ms/naafaq | FAQ page}.
15646
15652
  *
15647
15653
  * - You can pass both the token and either an attachment identifier or item identifier to an external system. That system uses
15648
15654
  * the token as a bearer authorization token to call the Exchange Web Services (EWS)
@@ -15667,11 +15673,20 @@ declare namespace Office {
15667
15673
  *
15668
15674
  * **Errors**:
15669
15675
  *
15670
- * - `HTTPRequestFailure`: The request has failed. Please look at the diagnostics object for the HTTP error code.
15676
+ * If your call fails, use the {@link https://learn.microsoft.com/javascript/api/office/office.asyncresult#office-office-asyncresult-diagnostics-member | asyncResult.diagnostics}
15677
+ * property to view details about the error.
15678
+ *
15679
+ * - `GenericTokenError: An internal error has occurred.` - In Exchange Online environments, this error occurs when the token can't be retrieved because legacy Exchange tokens
15680
+ * for Outlook add-ins are turned off. We recommend using NAA as a single sign-on solution for your add-in. For guidance on how to implement NAA, see the
15681
+ * {@link https://aka.ms/naafaq | FAQ page}.
15671
15682
  *
15672
- * - `InternalServerError`: The Exchange server returned an error. Please look at the diagnostics object for more information.
15683
+ * - `HTTPRequestFailure: The request has failed. Please look at the diagnostics object for the HTTP error code.`
15673
15684
  *
15674
- * - `NetworkError`: The user is no longer connected to the network. Please check your network connection and try again.
15685
+ * - `InternalServerError: The Exchange server returned an error. Please look at the diagnostics object for more information.` - In Exchange Online environments,
15686
+ * this error occurs when the token can't be retrieved because legacy Exchange tokens for Outlook add-ins are turned off. We recommend using NAA as a single sign-on solution for your add-in.
15687
+ * For guidance on how to implement NAA, see the {@link https://aka.ms/naafaq | FAQ page}.
15688
+ *
15689
+ * - `NetworkError: The user is no longer connected to the network. Please check your network connection and try again.`
15675
15690
  *
15676
15691
  * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of
15677
15692
  * type `Office.AsyncResult`. The token is returned as a string in the `asyncResult.value` property.
@@ -15803,12 +15818,11 @@ declare namespace Office {
15803
15818
  *
15804
15819
  * **Important**:
15805
15820
  *
15806
- * - In October 2024, legacy Exchange {@link https://learn.microsoft.com/office/dev/add-ins/outlook/authentication#exchange-user-identity-token | user identity} and
15821
+ * - In February 2025, legacy Exchange {@link https://learn.microsoft.com/office/dev/add-ins/outlook/authentication#exchange-user-identity-token | user identity} and
15807
15822
  * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/authentication#callback-tokens | callback} tokens will be turned off by default for all Exchange Online tenants.
15808
15823
  * This is part of {@link https://blogs.microsoft.com/on-the-issues/2023/11/02/secure-future-initiative-sfi-cybersecurity-cyberattacks/ | Microsoft's Secure Future Initiative},
15809
15824
  * which gives organizations the tools needed to respond to the current threat landscape. Exchange user identity tokens will still work for Exchange on-premises.
15810
- * Nested app authentication is the recommended approach for tokens going forward. For more information, see our {@link https://aka.ms/NAApreviewblog | blog post} and
15811
- * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/faq-nested-app-auth-outlook-legacy-tokens | FAQ page}.
15825
+ * Nested app authentication (NAA) is the recommended approach for tokens going forward. For more information, see the {@link https://aka.ms/naafaq | FAQ page}.
15812
15826
  *
15813
15827
  * - The `getUserIdentityTokenAsync` method returns a token that you can use to identify and
15814
15828
  * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/authentication | authenticate the add-in and user with an external system}.
@@ -15817,11 +15831,20 @@ declare namespace Office {
15817
15831
  *
15818
15832
  * **Errors**:
15819
15833
  *
15820
- * - `HTTPRequestFailure`: The request has failed. Please look at the diagnostics object for the HTTP error code.
15834
+ * If your call fails, use the {@link https://learn.microsoft.com/javascript/api/office/office.asyncresult#office-office-asyncresult-diagnostics-member | asyncResult.diagnostics}
15835
+ * property to view details about the error.
15836
+ *
15837
+ * - `GenericTokenError: An internal error has occurred.` - In Exchange Online environments, this error occurs when the token can't be retrieved because legacy Exchange tokens
15838
+ * for Outlook add-ins are turned off. We recommend using NAA as a single sign-on solution for your add-in. For guidance on how to implement NAA, see the
15839
+ * {@link https://aka.ms/naafaq | FAQ page}.
15840
+ *
15841
+ * - `HTTPRequestFailure: The request has failed. Please look at the diagnostics object for the HTTP error code.`
15821
15842
  *
15822
- * - `InternalServerError`: The Exchange server returned an error. Please look at the diagnostics object for more information.
15843
+ * - `InternalServerError: The Exchange server returned an error. Please look at the diagnostics object for more information.` - In Exchange Online environments,
15844
+ * this error occurs when the token can't be retrieved because legacy Exchange tokens for Outlook add-ins are turned off. We recommend using NAA as a single sign-on solution for your add-in.
15845
+ * For guidance on how to implement NAA, see the {@link https://aka.ms/naafaq | FAQ page}.
15823
15846
  *
15824
- * - `NetworkError`: The user is no longer connected to the network. Please check your network connection and try again.
15847
+ * - `NetworkError: The user is no longer connected to the network. Please check your network connection and try again.`
15825
15848
  *
15826
15849
  * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of
15827
15850
  * type `Office.AsyncResult`.
@@ -15844,12 +15867,11 @@ declare namespace Office {
15844
15867
  *
15845
15868
  * **Important**:
15846
15869
  *
15847
- * - In October 2024, legacy Exchange {@link https://learn.microsoft.com/office/dev/add-ins/outlook/authentication#exchange-user-identity-token | user identity} and
15870
+ * - In February 2025, legacy Exchange {@link https://learn.microsoft.com/office/dev/add-ins/outlook/authentication#exchange-user-identity-token | user identity} and
15848
15871
  * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/authentication#callback-tokens | callback} tokens will be turned off by default for all Exchange Online tenants.
15849
15872
  * This is part of {@link https://blogs.microsoft.com/on-the-issues/2023/11/02/secure-future-initiative-sfi-cybersecurity-cyberattacks/ | Microsoft's Secure Future Initiative},
15850
15873
  * which gives organizations the tools needed to respond to the current threat landscape. Exchange user identity tokens will still work for Exchange on-premises.
15851
- * Nested app authentication is the recommended approach for tokens going forward. For more information, see our {@link https://aka.ms/NAApreviewblog | blog post} and
15852
- * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/faq-nested-app-auth-outlook-legacy-tokens | FAQ page}.
15874
+ * Nested app authentication (NAA) is the recommended approach for tokens going forward. For more information, see the {@link https://aka.ms/naafaq | FAQ page}.
15853
15875
  *
15854
15876
  * - To enable the `makeEwsRequestAsync` method to make EWS requests, the server administrator must set `OAuthAuthentication` to `true` on the
15855
15877
  * Client Access Server EWS directory .
office-js/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js",
3
- "version": "1.0.451",
3
+ "version": "1.0.452",
4
4
  "description": "TypeScript definitions for office-js",
5
5
  "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js",
6
6
  "license": "MIT",
@@ -46,6 +46,6 @@
46
46
  "scripts": {},
47
47
  "dependencies": {},
48
48
  "peerDependencies": {},
49
- "typesPublisherContentHash": "e2c1416302d1bebe4b1c0e18a3297b24e7f38e0ec20224bffdfad6d2167c80c1",
49
+ "typesPublisherContentHash": "079ff37e77aaa4f1950bc4643adde2acb62b4dd54858b9ec11daa674fbc97652",
50
50
  "typeScriptVersion": "5.0"
51
51
  }