@itwin/map-layers-auth 3.4.0-dev.9 → 3.5.0-dev.4

package/CHANGELOG.md

@@ -1,6 +1,28 @@
 # Change Log - @itwin/map-layers-auth
 
-This log was last generated on Tue, 09 Aug 2022 15:52:41 GMT and should not be manually modified.
+This log was last generated on Thu, 01 Sep 2022 14:37:22 GMT and should not be manually modified.
+
+## 3.3.2
+Thu, 01 Sep 2022 14:37:22 GMT
+
+_Version update only_
+
+## 3.3.1
+Fri, 26 Aug 2022 15:40:02 GMT
+
+_Version update only_
+
+## 3.3.0
+Thu, 18 Aug 2022 19:08:02 GMT
+
+### Updates
+
+- upgrade mocha to version 10.0.0
+
+## 3.2.9
+Fri, 26 Aug 2022 14:21:40 GMT
+
+_Version update only_
 
 ## 3.2.8
 Tue, 09 Aug 2022 15:52:41 GMT

package/README.md

@@ -6,15 +6,16 @@ Copyright © Bentley Systems, Incorporated. All rights reserved. See LICENSE.md
 
 The __@itwin/map-layers-auth__ package contains classes for enabling various authentification methods, such as OAuth2.
 
-## ArcGIS OAuth2 suport
+## ArcGIS OAuth2 support
 
-To enable the ArcGIS OAuth2 suport, an 'ArcGisAccessClient' object needs to be created and registered in the MapLayerFormatRegistry from __@itwin/imodeljs-frontend__ for the 'ArcGIS' format.
+To enable the ArcGIS OAuth2 support, an 'ArcGisAccessClient' object needs to be created and registered in the MapLayerFormatRegistry from __@itwin/imodeljs-frontend__ for the 'ArcGIS' format.
 
-Also the following configuration will be required: 
+Also the following configuration will be required:
 
 1. __Callback URL__\
-Hosting application needs implement its own callback page, and set its URL on the create `ArcGisAccessClient` object.\
-Following code demonstrates how this can be implemented as a simple React hook:
+Hosting application needs to implement its own callback page, and sets its corresponding public URL on the  `ArcGisAccessClient` object.\
+Following code demonstrates how a callback page can be implemented as a simple React hook:
+
 ```
 import * as React from "react";
 export function ArcGisOauthRedirect() {
@@ -32,13 +33,14 @@ export function ArcGisOauthRedirect() {
 }
 ```
 
-2. __Client IDs__\
-The hosting application must be registered in either the ArcGIS Online server (cloud offering) or an ArcGIS enterprise server (on-premise). The registered application must then provide it's associated clientID and redirectUri to the `ArcGgisAccessClient` object.  The ui-test-app application provides a complete sample configuration. 
-The maplayers widget has also been updated to support OAuth2: if needed, a popup window will be displayed to trigger the external OAuth process with the remote ArcGIS server. When the process completes, the focus returns to the map-layers widget and layer is ready to be added/displayed.\
+1. __Client IDs__\
+The hosting application must be registered in either the ArcGIS Online server (cloud offering) or in ArcGIS enterprise server (on-premise). The registered application must then provide its associated clientID and redirectUri to the `ArcGisAccessClient` object.  The ui-test-app application provides a complete sample configuration.
+The map-layers widget has also been updated to support OAuth2: if needed, a popup window will be displayed to trigger the external OAuth process with the remote ArcGIS server. When the process completes, the focus returns to the map-layers widget and layer is ready to be added/displayed.\
 \
 More details on how to configure the ArcGis Server can be found in the [ESRI documentation](https://developers.arcgis.com/documentation/mapping-apis-and-services/security/tutorials/register-your-application/)\
 \
 `ArcGisAccessClient` initialization example:
+
 ```ts
   const enterpriseClientIds = [{
       serviceBaseUrl: SampleAppIModelApp.testAppConfiguration.arcGisEnterpriseBaseUrl,
@@ -53,5 +55,3 @@ More details on how to configure the ArcGis Server can be found in the [ESRI doc
     }});
   IModelApp.mapLayerFormatRegistry.setAccessClient("ArcGIS", accessClient);
 ```
-
-

package/lib/cjs/ArcGis/ArcGisAccessClient.d.ts

@@ -1,67 +1,67 @@
-/** @packageDocumentation
- * @module Tiles
- */
-import { BeEvent } from "@itwin/core-bentley";
-import { MapLayerAccessClient, MapLayerAccessToken, MapLayerAccessTokenParams, MapLayerTokenEndpoint } from "@itwin/core-frontend";
-/** @beta */
-export interface ArcGisEnterpriseClientId {
-    serviceBaseUrl: string;
-    clientId: string;
-}
-/** @beta */
-export interface ArcGisOAuthClientIds {
-    arcgisOnlineClientId?: string;
-    enterpriseClientIds?: ArcGisEnterpriseClientId[];
-}
-/** @beta
- * ArcGIS OAuth configurations parameters.
- * See https://developers.arcgis.com/documentation/mapping-apis-and-services/security/arcgis-identity/serverless-web-apps/
- * more details.
-*/
-export interface ArcGisOAuthConfig {
-    redirectUri: string;
-    tokenExpiration?: number;
-    clientIds: ArcGisOAuthClientIds;
-}
-/** @beta */
-export declare class ArcGisAccessClient implements MapLayerAccessClient {
-    readonly onOAuthProcessEnd: BeEvent<import("@itwin/core-bentley").Listener>;
-    private _redirectUri;
-    private _expiration;
-    private _clientIds;
-    constructor();
-    initialize(oAuthConfig?: ArcGisOAuthConfig): boolean;
-    private initOauthCallbackFunction;
-    unInitialize(): void;
-    getAccessToken(params: MapLayerAccessTokenParams): Promise<MapLayerAccessToken | undefined>;
-    getTokenServiceEndPoint(mapLayerUrl: string): Promise<MapLayerTokenEndpoint | undefined>;
-    invalidateToken(token: MapLayerAccessToken): boolean;
-    get redirectUri(): string | undefined;
-    getMatchingEnterpriseClientId(url: string): string | undefined;
-    get expiration(): number | undefined;
-    get arcGisOnlineClientId(): string | undefined;
-    set arcGisOnlineClientId(clientId: string | undefined);
-    get arcGisEnterpriseClientIds(): ArcGisEnterpriseClientId[] | undefined;
-    setEnterpriseClientId(serviceBaseUrl: string, clientId: string): void;
-    removeEnterpriseClientId(clientId: ArcGisEnterpriseClientId): void;
-    /** @internal */
-    private getOAuthTokenForMapLayerUrl;
-    /**
-    * Test if Oauth2 endpoint is accessible and has an associated appId
-    * @internal
-    */
-    private validateOAuth2Endpoint;
-    private _oauthAuthorizeEndPointsCache;
-    private _oauthTokenEndPointsCache;
-    /**
-   * Get OAuth2 endpoint that must be cause to get the Oauth2 token
-   * @internal
-   */
-    private getOAuth2Endpoint;
-    /**
-   * Construct the complete Authorize url to starts the Oauth process
-   * @internal
-   */
-    private constructLoginUrl;
-}
+/** @packageDocumentation
+ * @module Tiles
+ */
+import { BeEvent } from "@itwin/core-bentley";
+import { MapLayerAccessClient, MapLayerAccessToken, MapLayerAccessTokenParams, MapLayerTokenEndpoint } from "@itwin/core-frontend";
+/** @beta */
+export interface ArcGisEnterpriseClientId {
+    serviceBaseUrl: string;
+    clientId: string;
+}
+/** @beta */
+export interface ArcGisOAuthClientIds {
+    arcgisOnlineClientId?: string;
+    enterpriseClientIds?: ArcGisEnterpriseClientId[];
+}
+/** @beta
+ * ArcGIS OAuth configurations parameters.
+ * See https://developers.arcgis.com/documentation/mapping-apis-and-services/security/arcgis-identity/serverless-web-apps/
+ * more details.
+*/
+export interface ArcGisOAuthConfig {
+    redirectUri: string;
+    tokenExpiration?: number;
+    clientIds: ArcGisOAuthClientIds;
+}
+/** @beta */
+export declare class ArcGisAccessClient implements MapLayerAccessClient {
+    readonly onOAuthProcessEnd: BeEvent<import("@itwin/core-bentley").Listener>;
+    private _redirectUri;
+    private _expiration;
+    private _clientIds;
+    constructor();
+    initialize(oAuthConfig?: ArcGisOAuthConfig): boolean;
+    private initOauthCallbackFunction;
+    unInitialize(): void;
+    getAccessToken(params: MapLayerAccessTokenParams): Promise<MapLayerAccessToken | undefined>;
+    getTokenServiceEndPoint(mapLayerUrl: string): Promise<MapLayerTokenEndpoint | undefined>;
+    invalidateToken(token: MapLayerAccessToken): boolean;
+    get redirectUri(): string | undefined;
+    getMatchingEnterpriseClientId(url: string): string | undefined;
+    get expiration(): number | undefined;
+    get arcGisOnlineClientId(): string | undefined;
+    set arcGisOnlineClientId(clientId: string | undefined);
+    get arcGisEnterpriseClientIds(): ArcGisEnterpriseClientId[] | undefined;
+    setEnterpriseClientId(serviceBaseUrl: string, clientId: string): void;
+    removeEnterpriseClientId(clientId: ArcGisEnterpriseClientId): void;
+    /** @internal */
+    private getOAuthTokenForMapLayerUrl;
+    /**
+    * Test if Oauth2 endpoint is accessible and has an associated appId
+    * @internal
+    */
+    private validateOAuth2Endpoint;
+    private _oauthAuthorizeEndPointsCache;
+    private _oauthTokenEndPointsCache;
+    /**
+   * Get OAuth2 endpoint that must be cause to get the Oauth2 token
+   * @internal
+   */
+    private getOAuth2Endpoint;
+    /**
+   * Construct the complete Authorize url to starts the Oauth process
+   * @internal
+   */
+    private constructLoginUrl;
+}
 //# sourceMappingURL=ArcGisAccessClient.d.ts.map