@esri/solutions-components 5.1.0-next.7 → 5.1.0-next.71

package/dist/chunks/Auth.js

@@ -1,25 +1,39 @@
 /* COPYRIGHT Esri - https://js.arcgis.com/5.1/LICENSE.txt */
-import * as n from "@esri/solution-common";
-import a from "@arcgis/core/identity/IdentityManager.js";
-import h from "@arcgis/core/identity/OAuthInfo.js";
-import c from "@arcgis/core/portal/Portal.js";
-class g {
-  constructor(e, t, r, s) {
-    this._credential = void 0, this._isEnterprise = !1, this._locale = "en", this._portalSubset = void 0, this._portalUserSubset = void 0, this._searchArcGISOnlineEnabled = !0, this._signInParam = void 0, this._clientId = e ?? "", this._locale = r ?? "en", this._portalUrl = t ?? "https://www.arcgis.com", this._portalRestUrl = this._portalUrl + "/sharing/rest", this._portalUrl = location.origin.endsWith(".arcgis.com") ? window.location.origin : this._portalUrl, this._signInParam = s;
-    const i = new h({
+import * as common from "@esri/solution-common";
+import IdentityManager from "@arcgis/core/identity/IdentityManager.js";
+import OAuthInfo from "@arcgis/core/identity/OAuthInfo.js";
+import x from "@arcgis/core/portal/Portal.js";
+import { x as getAnonymousPortalUrl, y as removeUrlParamValue } from "./helpers.js";
+class Auth {
+  constructor(clientId, portalURL, locale, signInParam) {
+    this._credential = void 0;
+    this._isEnterprise = false;
+    this._locale = "en";
+    this._portalSubset = void 0;
+    this._portalUserSubset = void 0;
+    this._arcGISOnlineReachable = true;
+    this._searchArcGISOnlineEnabled = true;
+    this._signInParam = void 0;
+    this._clientId = clientId ?? "";
+    this._locale = locale ?? "en";
+    this._portalUrl = portalURL ?? "https://www.arcgis.com";
+    this._portalRestUrl = this._portalUrl + "/sharing/rest";
+    this._portalUrl = location.origin.endsWith(".arcgis.com") ? window.location.origin : this._portalUrl;
+    this._signInParam = signInParam;
+    const info = new OAuthInfo({
       appId: this._clientId,
       locale: this._locale,
-      popup: !1,
+      popup: false,
       // inline redirects don't require any additional app configuration
       portalUrl: this._portalUrl,
-      preserveUrlHash: !0
+      preserveUrlHash: true
     });
     try {
-      a.registerOAuthInfos([i]);
-    } catch (o) {
-      console.log(o);
+      IdentityManager.registerOAuthInfos([info]);
+    } catch (error) {
+      console.log(error);
     }
-    this._portal = new c({ url: this._portalUrl });
+    this._portal = new x({ url: this._portalUrl });
   }
   get Credential() {
     return this._credential;
@@ -49,8 +63,11 @@ class g {
     return this._portalUserSubset;
   }
   get PortalUserPrivileges() {
-    let e = [];
-    return this._portalUserSubset?.privileges && (e = this._portalUserSubset.privileges), e;
+    let privileges = [];
+    if (this._portalUserSubset?.privileges) {
+      privileges = this._portalUserSubset.privileges;
+    }
+    return privileges;
   }
   get SignInParam() {
     return this._signInParam;
@@ -62,18 +79,47 @@ class g {
     return this.PortalUserPrivileges.includes("portal:admin:updateItems");
   }
   get CanUseAI() {
-    const e = this._portalSubset?.orgSettings, t = this.PortalUserPrivileges.includes("portal:user:useAIAssistants");
-    return e?.aiAssistantsEnabled ? e.aiAssistantsEnabled && !e.blockBetaApps && t : !1;
+    const orgSettings = this._portalSubset?.orgSettings;
+    const hasPrivilege = this.PortalUserPrivileges.includes("portal:user:useAIAssistants");
+    if (orgSettings?.aiAssistantsEnabled) {
+      return orgSettings.aiAssistantsEnabled && !orgSettings.blockBetaApps && hasPrivilege;
+    }
+    return false;
   }
   get CanViewOrg() {
     return this.PortalUserPrivileges.includes("portal:admin:viewItems");
   }
   get CanSearchArcGISOnline() {
-    return this._searchArcGISOnlineEnabled;
+    return this._searchArcGISOnlineEnabled && this._arcGISOnlineReachable;
+  }
+  /** Checks if the ArcGIS Online group is reachable for Enterprise portals. */
+  async checkArcGISOnlineReachability(agoBasedEnterpriseSolutionsGroupId) {
+    if (this._isEnterprise && this._searchArcGISOnlineEnabled && agoBasedEnterpriseSolutionsGroupId) {
+      const agolPortalUrl = getAnonymousPortalUrl(this._portalUrl);
+      const agolRestUrl = `${agolPortalUrl}/sharing/rest`;
+      const anonAgolSession = new common.UserSession({});
+      try {
+        await common.searchItems({
+          q: `group:${agoBasedEnterpriseSolutionsGroupId} type:Solution`,
+          num: 1,
+          start: 1,
+          authentication: anonAgolSession,
+          portal: agolRestUrl
+        });
+        this._arcGISOnlineReachable = true;
+      } catch (error) {
+        this._arcGISOnlineReachable = false;
+        console.warn("ArcGIS Online solutions group not reachable:", error);
+      }
+    }
   }
   get RestUserSession() {
-    const e = a.findServerInfo(this._portalRestUrl), t = this._credential ? n.UserSession.fromCredential(this._credential, e) : this._isEnterprise ? new n.UserSession({}) : new n.UserSession({ portal: this._portalRestUrl });
-    return t.portal = this.PortalSubset?.restUrl ? this.PortalSubset?.restUrl : t.portal, t.clientId = this._credential?._oAuthCred?.appId, t._refreshToken = this._credential?._oAuthCred?.refreshToken, t;
+    const serverInfo = IdentityManager.findServerInfo(this._portalRestUrl);
+    const userSession = this._credential ? common.UserSession.fromCredential(this._credential, serverInfo) : this._isEnterprise ? new common.UserSession({}) : new common.UserSession({ portal: this._portalRestUrl });
+    userSession.portal = this.PortalSubset?.restUrl ? this.PortalSubset?.restUrl : userSession.portal;
+    userSession.clientId = this._credential?._oAuthCred?.appId;
+    userSession._refreshToken = this._credential?._oAuthCred?.refreshToken;
+    return userSession;
   }
   /**
    * Initializes the Auth object. This method must be called before any other Auth methods.
@@ -81,16 +127,19 @@ class g {
    *
    * @returns Promise that resolves with the initialized Auth object
    */
-  async initialize() {
+  async initialize(isEnterprise = false, agoBasedEnterpriseSolutionsGroupId) {
     try {
-      await this._init();
-    } catch {
+      await this._init(isEnterprise, agoBasedEnterpriseSolutionsGroupId);
+    } catch (err) {
       this.destroy();
     }
     return this;
   }
   destroy() {
-    this._credential = void 0, this._portalSubset = void 0, this._portalUserSubset = void 0, a.destroyCredentials();
+    this._credential = void 0;
+    this._portalSubset = void 0;
+    this._portalUserSubset = void 0;
+    IdentityManager.destroyCredentials();
   }
   /**
    * Signs into app and refreshes the window.location or switches to the supplied URL.
@@ -98,19 +147,26 @@ class g {
    * @param signInParamValue If supplied, the parameter `signInParam` with the supplied value
    * will be added to the redirect uri's search params
    */
-  async signIn(e = "") {
-    a.setOAuthRedirectionHandler((t) => {
-      const r = t.authorizeParams.redirect_uri;
-      if (e.length > 0) {
-        const s = r.split("?"), i = s[0];
-        let o = "";
-        const l = new URLSearchParams(s[1] || "");
-        l.append("signInParam", e), o = "?" + l.toString(), t.authorizeParams.redirect_uri = i + o;
+  async signIn(signInParamValue = "") {
+    IdentityManager.setOAuthRedirectionHandler((info) => {
+      const redirectUri = info.authorizeParams.redirect_uri;
+      if (signInParamValue.length > 0) {
+        const redirectUriParts = redirectUri.split("?");
+        const redirectOriginPath = redirectUriParts[0];
+        let redirectSearch = "";
+        const redirectSearchParams = new URLSearchParams(redirectUriParts[1] || "");
+        redirectSearchParams.append("signInParam", signInParamValue);
+        redirectSearch = "?" + redirectSearchParams.toString();
+        info.authorizeParams.redirect_uri = redirectOriginPath + redirectSearch;
       }
-      window.location.href = t.authorizeUrl + "?" + this._objectToQuery(t.authorizeParams);
-    }), await a.getCredential((this._portalSubset?.portalUrl ?? this._portalUrl) + "/sharing").then(
-      (t) => {
-        t && window.location.reload();
+      window.location.href = info.authorizeUrl + "?" + this._objectToQuery(info.authorizeParams);
+      return;
+    });
+    await IdentityManager.getCredential((this._portalSubset?.portalUrl ?? this._portalUrl) + "/sharing").then(
+      (credential) => {
+        if (credential) {
+          window.location.reload();
+        }
       }
     );
   }
@@ -124,18 +180,24 @@ class g {
    *  on the resources page they should stay on that page
    */
   signOut() {
-    const e = window.location.href, t = /[\/]\b([0-9A-Fa-f]){32}\b/g;
-    let r = e.match(t) ? e.replace(t, "") : e;
-    const i = `${this._portal?.restUrl ?? this._portalUrl + "/sharing/rest"}/oauth2/signout?client_id=${this._clientId}&redirect_uri=${encodeURIComponent(r)}`;
-    this.destroy(), window.location.replace(i);
+    const href = window.location.href;
+    const idRegEx = /[\/]\b([0-9A-Fa-f]){32}\b/g;
+    let redirectUrl = href.match(idRegEx) ? href.replace(idRegEx, "") : href;
+    redirectUrl = removeUrlParamValue(redirectUrl, "sortField", "suggested");
+    const restUrl = this._portal?.restUrl ?? this._portalUrl + "/sharing/rest";
+    const signOutUrl = `${restUrl}/oauth2/signout?client_id=${this._clientId}&redirect_uri=${encodeURIComponent(redirectUrl)}`;
+    this.destroy();
+    window.location.replace(signOutUrl);
   }
   /**
    * Refreshes the user session token
    */
   refreshSession() {
-    const e = this.RestUserSession;
-    if (!(!e || !this.IsSignedIn))
-      return e.exchangeRefreshToken();
+    const userSession = this.RestUserSession;
+    if (!userSession || !this.IsSignedIn) {
+      return void 0;
+    }
+    return userSession.exchangeRefreshToken();
   }
   // ---------------------------------------------------------------------------------------------------------------- //
   /**
@@ -145,39 +207,40 @@ class g {
    * @param portalCustomBaseUrl The custom base URL for the portal.
    * @returns
    */
-  _getOrgUrl(e, t, r) {
-    return t && r ? window.location.protocol + "//" + t.toLowerCase() + "." + r : e;
+  _getOrgUrl(portalUrl, portalUrlKey, portalCustomBaseUrl) {
+    if (portalUrlKey && portalCustomBaseUrl) {
+      return window.location.protocol + "//" + portalUrlKey.toLowerCase() + "." + portalCustomBaseUrl;
+    } else {
+      return portalUrl;
+    }
   }
   /**
    * Initializes the Auth object. This method must be called before any other Auth methods.
    * If the user is not authorized to use the app, the page will be redirected to an error page.
    * @returns Promise that resolves with the initialized Auth object
    */
-  async _init() {
+  async _init(isEnterprise = false, agoBasedEnterpriseSolutionsGroupId) {
     try {
-      this._credential = await a.checkSignInStatus(this._portalUrl + "/sharing");
-    } catch {
+      this._credential = await IdentityManager.checkSignInStatus(this._portalUrl + "/sharing");
+    } catch (error) {
+      console.log(error);
     }
     try {
-      const t = await a.checkAppAccess(this._portalUrl + "/sharing", this._clientId);
-      (typeof t.valid < "u" && !t.valid || t.viewOnlyUserTypeApp) && window.location.replace(`error.html?error=blocked&locale=${this._locale}`), this._credential = t.credential;
-    } catch (t) {
-      t.name;
-    }
-    this._portal.authMode = "auto", await this._portal.load();
-    const e = this._credential ? await n.getOrganizationSettings(this.RestUserSession) : {};
-    if (this._isEnterprise = this._portal.isPortal, this._isEnterprise)
-      try {
-        const t = `${this._portal.restUrl}/portals/self/settings`, r = await n.request(t, {
-          authentication: this._credential ? this.RestUserSession : void 0
-        });
-        r?.portalConfigProperties?.searchArcGISOnlineEnabled !== void 0 ? this._searchArcGISOnlineEnabled = r.portalConfigProperties.searchArcGISOnlineEnabled : this._searchArcGISOnlineEnabled = !1;
-      } catch (t) {
-        console.warn("Failed to fetch portal settings:", t), this._searchArcGISOnlineEnabled = !1;
+      const response = await IdentityManager.checkAppAccess(this._portalUrl + "/sharing", this._clientId);
+      if (typeof response.valid !== "undefined" && !response.valid || response.viewOnlyUserTypeApp) {
+        window.location.replace(`error.html?error=blocked&locale=${this._locale}`);
       }
-    else
-      this._searchArcGISOnlineEnabled = !0;
-    return this._portalSubset = {
+      this._credential = response.credential;
+    } catch (err) {
+      if (err.name !== "identity-manager:not-authenticated") ;
+    }
+    this._searchArcGISOnlineEnabled = await this._checkSearchArcGISOnlineEnabled(isEnterprise, this._portal.restUrl);
+    this._portal.authMode = isEnterprise ? "immediate" : "auto";
+    await this._portal.load();
+    const orgSettings = this._credential ? await common.getOrganizationSettings(this.RestUserSession) : {};
+    this._isEnterprise = this._portal.isPortal;
+    await this.checkArcGISOnlineReachability(agoBasedEnterpriseSolutionsGroupId);
+    this._portalSubset = {
       name: this._portal.name ?? "",
       id: this._portal.id ?? "",
       restUrl: this._portal.restUrl ?? "",
@@ -186,11 +249,12 @@ class g {
       hostName: this._portal.portalHostname ?? "",
       orgUrl: this._getOrgUrl(this._portal.url, this._portal.urlKey ?? "", this._portal.customBaseUrl ?? ""),
       locationTrackingEnabled: this._portal.helperServices.hasOwnProperty("locationTracking"),
-      hubPremiumEnabled: this._portal.portalProperties?.hub?.enabled || !1,
+      hubPremiumEnabled: this._portal.portalProperties?.hub?.enabled || false,
       workflowURL: this._portal.helperServices?.workflowManager?.url ?? this._portal.url,
       isReadOnly: this._portal.isReadOnly,
-      orgSettings: e
-    }, this._portalUserSubset = {
+      orgSettings
+    };
+    this._portalUserSubset = {
       fullName: this._portal.user?.fullName ?? "",
       username: this._portal.user?.username ?? "",
       culture: this._portal.user?.culture?.toLowerCase() || "en",
@@ -199,10 +263,37 @@ class g {
       privileges: this._portal.user.privileges,
       role: this._portal.user?.role ?? "",
       roleId: this._portal.user?.roleId ?? void 0
-    }, this._isEnterprise && this._portalSubset && (this._portalSubset.workflowURL = await n.getWorkflowEnterpriseServerRootURL(
-      this._portal.restUrl,
-      this.RestUserSession || new n.UserSession({})
-    )), this._portal?.user?.roleId && this._portalUserSubset && (this._portalUserSubset.roleId = this._portal.user.roleId), this;
+    };
+    if (this._isEnterprise && this._portalSubset) {
+      this._portalSubset.workflowURL = await common.getWorkflowEnterpriseServerRootURL(
+        this._portal.restUrl,
+        this.RestUserSession || new common.UserSession({})
+      );
+    }
+    if (this._portal?.user?.roleId && this._portalUserSubset) {
+      this._portalUserSubset.roleId = this._portal.user.roleId;
+    }
+    return this;
+  }
+  async _checkSearchArcGISOnlineEnabled(isEnterprise, portalRestUrl) {
+    if (isEnterprise) {
+      try {
+        const portalSettingsUrl = `${portalRestUrl}/portals/self/settings`;
+        const portalSettings = await common.request(portalSettingsUrl, {
+          authentication: this._credential ? this.RestUserSession : void 0
+        });
+        if (portalSettings?.portalConfigProperties?.searchArcGISOnlineEnabled !== void 0) {
+          return portalSettings.portalConfigProperties.searchArcGISOnlineEnabled;
+        } else {
+          return false;
+        }
+      } catch (error) {
+        console.warn("Failed to fetch portal settings:", error);
+        return false;
+      }
+    } else {
+      return true;
+    }
   }
   /**
    * Checks if an object is serializable.
@@ -210,8 +301,8 @@ class g {
    * This function checks if the object has a `toJSON` method, which is a
    * @returns Boolean indicating whether the object is serializable.
    */
-  _isSerializable(e) {
-    return e && typeof e == "object" && "toJSON" in e && typeof e.toJSON == "function";
+  _isSerializable(obj) {
+    return obj && typeof obj === "object" && "toJSON" in obj && typeof obj.toJSON === "function";
   }
   /**
    * Converts a hashmap of query parameters to a query string. Following formatting rules applies:
@@ -246,16 +337,38 @@ class g {
    *
    * Copied from function exported in arcgis-js-api but not added to JSAPI.
    */
-  _objectToQuery(e, t) {
-    return e ? t && typeof t == "function" ? Object.keys(e).map((r) => encodeURIComponent(r) + "=" + encodeURIComponent(t(r, e[r]))).join("&") : Object.keys(e).map((r) => {
-      const s = e[r];
-      if (s == null)
+  _objectToQuery(queryParameters, replacers) {
+    if (!queryParameters) {
+      return "";
+    }
+    if (replacers && typeof replacers === "function") {
+      return Object.keys(queryParameters).map((key) => encodeURIComponent(key) + "=" + encodeURIComponent(replacers(key, queryParameters[key]))).join("&");
+    }
+    return Object.keys(queryParameters).map((key) => {
+      const value = queryParameters[key];
+      if (value == void 0) {
         return "";
-      const i = encodeURIComponent(r) + "=", o = t && t[r];
-      return o ? i + encodeURIComponent(o(s)) : Array.isArray(s) ? s.map((l) => this._isSerializable(l) ? i + encodeURIComponent(JSON.stringify(l)) : i + encodeURIComponent(l)).join("&") : this._isSerializable(s) ? i + encodeURIComponent(JSON.stringify(s)) : i + encodeURIComponent(s);
-    }).filter((r) => r).join("&") : "";
+      }
+      const assign = encodeURIComponent(key) + "=";
+      const replacer = replacers && replacers[key];
+      if (replacer) {
+        return assign + encodeURIComponent(replacer(value));
+      }
+      if (Array.isArray(value)) {
+        return value.map((child) => {
+          if (this._isSerializable(child)) {
+            return assign + encodeURIComponent(JSON.stringify(child));
+          }
+          return assign + encodeURIComponent(child);
+        }).join("&");
+      }
+      if (this._isSerializable(value)) {
+        return assign + encodeURIComponent(JSON.stringify(value));
+      }
+      return assign + encodeURIComponent(value);
+    }).filter((value) => value).join("&");
   }
 }
 export {
-  g as A
+  Auth as A
 };