@esri/solutions-components 5.1.0-next.10 → 5.1.0-next.101

package/dist/chunks/Auth.js

@@ -1,11 +1,12 @@
 /* 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 * as o from "@esri/solution-common";
+import n from "@arcgis/core/identity/IdentityManager.js";
 import h from "@arcgis/core/identity/OAuthInfo.js";
 import c from "@arcgis/core/portal/Portal.js";
-class g {
+import { g as p, r as u } from "./helpers.js";
+class f {
   constructor(t, e, 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 = t ?? "", this._locale = r ?? "en", this._portalUrl = e ?? "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;
+    this._credential = void 0, this._isEnterprise = !1, this._locale = "en", this._portalSubset = void 0, this._portalUserSubset = void 0, this._arcGISOnlineReachable = !0, this._searchArcGISOnlineEnabled = !0, this._signInParam = void 0, this._clientId = t ?? "", this._locale = r ?? "en", this._portalUrl = e ?? "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({
       appId: this._clientId,
       locale: this._locale,
@@ -15,9 +16,9 @@ class g {
       preserveUrlHash: !0
     });
     try {
-      a.registerOAuthInfos([i]);
-    } catch (o) {
-      console.log(o);
+      n.registerOAuthInfos([i]);
+    } catch (a) {
+      console.log(a);
     }
     this._portal = new c({ url: this._portalUrl });
   }
@@ -69,10 +70,27 @@ class g {
     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(t) {
+    if (this._isEnterprise && this._searchArcGISOnlineEnabled && t) {
+      const r = `${p(this._portalUrl)}/sharing/rest`, s = new o.UserSession({});
+      try {
+        await o.searchItems({
+          q: `group:${t} type:Solution`,
+          num: 1,
+          start: 1,
+          authentication: s,
+          portal: r
+        }), this._arcGISOnlineReachable = !0;
+      } catch (i) {
+        this._arcGISOnlineReachable = !1, console.warn("ArcGIS Online solutions group not reachable:", i);
+      }
+    }
   }
   get RestUserSession() {
-    const t = a.findServerInfo(this._portalRestUrl), e = this._credential ? n.UserSession.fromCredential(this._credential, t) : this._isEnterprise ? new n.UserSession({}) : new n.UserSession({ portal: this._portalRestUrl });
+    const t = n.findServerInfo(this._portalRestUrl), e = this._credential ? o.UserSession.fromCredential(this._credential, t) : this._isEnterprise ? new o.UserSession({}) : new o.UserSession({ portal: this._portalRestUrl });
     return e.portal = this.PortalSubset?.restUrl ? this.PortalSubset?.restUrl : e.portal, e.clientId = this._credential?._oAuthCred?.appId, e._refreshToken = this._credential?._oAuthCred?.refreshToken, e;
   }
   /**
@@ -81,16 +99,16 @@ class g {
    *
    * @returns Promise that resolves with the initialized Auth object
    */
-  async initialize(t = !1) {
+  async initialize(t = !1, e) {
     try {
-      await this._init(t);
+      await this._init(t, e);
     } catch {
       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, n.destroyCredentials();
   }
   /**
    * Signs into app and refreshes the window.location or switches to the supplied URL.
@@ -99,16 +117,16 @@ class g {
    * will be added to the redirect uri's search params
    */
   async signIn(t = "") {
-    a.setOAuthRedirectionHandler((e) => {
+    n.setOAuthRedirectionHandler((e) => {
       const r = e.authorizeParams.redirect_uri;
       if (t.length > 0) {
         const s = r.split("?"), i = s[0];
-        let o = "";
+        let a = "";
         const l = new URLSearchParams(s[1] || "");
-        l.append("signInParam", t), o = "?" + l.toString(), e.authorizeParams.redirect_uri = i + o;
+        l.append("signInParam", t), a = "?" + l.toString(), e.authorizeParams.redirect_uri = i + a;
       }
       window.location.href = e.authorizeUrl + "?" + this._objectToQuery(e.authorizeParams);
-    }), await a.getCredential((this._portalSubset?.portalUrl ?? this._portalUrl) + "/sharing").then(
+    }), await n.getCredential((this._portalSubset?.portalUrl ?? this._portalUrl) + "/sharing").then(
       (e) => {
         e && window.location.reload();
       }
@@ -126,6 +144,7 @@ class g {
   signOut() {
     const t = window.location.href, e = /[\/]\b([0-9A-Fa-f]){32}\b/g;
     let r = t.match(e) ? t.replace(e, "") : t;
+    r = u(r, "sortField", "suggested");
     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);
   }
@@ -153,21 +172,21 @@ class g {
    * 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(t = !1) {
+  async _init(t = !1, e) {
     try {
-      this._credential = await a.checkSignInStatus(this._portalUrl + "/sharing");
-    } catch (r) {
-      console.log(r);
+      this._credential = await n.checkSignInStatus(this._portalUrl + "/sharing");
+    } catch (s) {
+      console.log(s);
     }
     try {
-      const r = await a.checkAppAccess(this._portalUrl + "/sharing", this._clientId);
-      (typeof r.valid < "u" && !r.valid || r.viewOnlyUserTypeApp) && window.location.replace(`error.html?error=blocked&locale=${this._locale}`), this._credential = r.credential;
-    } catch (r) {
-      r.name;
+      const s = await n.checkAppAccess(this._portalUrl + "/sharing", this._clientId);
+      (typeof s.valid < "u" && !s.valid || s.viewOnlyUserTypeApp) && window.location.replace(`error.html?error=blocked&locale=${this._locale}`), this._credential = s.credential;
+    } catch (s) {
+      s.name;
     }
     this._searchArcGISOnlineEnabled = await this._checkSearchArcGISOnlineEnabled(t, this._portal.restUrl), this._portal.authMode = t ? "immediate" : "auto", await this._portal.load();
-    const e = this._credential ? await n.getOrganizationSettings(this.RestUserSession) : {};
-    return this._isEnterprise = this._portal.isPortal, this._portalSubset = {
+    const r = this._credential ? await o.getOrganizationSettings(this.RestUserSession) : {};
+    return this._isEnterprise = this._portal.isPortal, await this.checkArcGISOnlineReachability(e), this._portalSubset = {
       name: this._portal.name ?? "",
       id: this._portal.id ?? "",
       restUrl: this._portal.restUrl ?? "",
@@ -179,7 +198,7 @@ class g {
       hubPremiumEnabled: this._portal.portalProperties?.hub?.enabled || !1,
       workflowURL: this._portal.helperServices?.workflowManager?.url ?? this._portal.url,
       isReadOnly: this._portal.isReadOnly,
-      orgSettings: e
+      orgSettings: r
     }, this._portalUserSubset = {
       fullName: this._portal.user?.fullName ?? "",
       username: this._portal.user?.username ?? "",
@@ -189,15 +208,15 @@ 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._isEnterprise && this._portalSubset && (this._portalSubset.workflowURL = await o.getWorkflowEnterpriseServerRootURL(
       this._portal.restUrl,
-      this.RestUserSession || new n.UserSession({})
+      this.RestUserSession || new o.UserSession({})
     )), this._portal?.user?.roleId && this._portalUserSubset && (this._portalUserSubset.roleId = this._portal.user.roleId), this;
   }
   async _checkSearchArcGISOnlineEnabled(t, e) {
     if (t)
       try {
-        const r = `${e}/portals/self/settings`, s = await n.request(r, {
+        const r = `${e}/portals/self/settings`, s = await o.request(r, {
           authentication: this._credential ? this.RestUserSession : void 0
         });
         return s?.portalConfigProperties?.searchArcGISOnlineEnabled !== void 0 ? s.portalConfigProperties.searchArcGISOnlineEnabled : !1;
@@ -254,11 +273,11 @@ class g {
       const s = t[r];
       if (s == null)
         return "";
-      const i = encodeURIComponent(r) + "=", o = e && e[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);
+      const i = encodeURIComponent(r) + "=", a = e && e[r];
+      return a ? i + encodeURIComponent(a(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("&") : "";
   }
 }
 export {
-  g as A
+  f as A
 };

package/dist/chunks/CardsFetcher.js

@@ -0,0 +1,287 @@
+/* COPYRIGHT Esri - https://js.arcgis.com/5.1/LICENSE.txt */
+import { s as p, c as A, e as d } from "./cardsHelpers.js";
+import * as c from "@esri/solution-common";
+import { g as D, b as v, c as E, d as b, e as I, f as J } from "./helpers.js";
+class M {
+  /**
+   * Constructor
+   *
+   * @param orgUrl URL of organization, e.g., "http://myOrg.maps.arcgis.com"
+   * @param portalUrl URL of portal, e.g., "https://www.arcgis.com"
+   * @param userSession Authentication
+   */
+  constructor(r, t, a) {
+    this.cMissingImageDataURI = "https://static.arcgis.com/images/solution.png", this.cardCache = [], this.cardCacheParams = {
+      q: "",
+      categoriesAsStr: "[]",
+      sortField: "title",
+      sortOrder: "asc"
+    }, this.locale = r, this.orgUrl = t, this.portalUrl = a, this.anonAgolSession = new c.UserSession({}), this.agolPortalUrl = D(a);
+  }
+  /**
+   * Adds a card to the cache to keep cache fresh between full refreshes.
+   *
+   * @param card Card to add
+   */
+  addToCache(r) {
+    this.cardCache.push(r);
+  }
+  /**
+   * Returns the current cache.
+   *
+   * @returns Cards in the cache
+   */
+  getCache() {
+    return this.cardCache;
+  }
+  /**
+   * Removes a card to the cache to keep cache fresh between full refreshes.
+   *
+   * @param id Id of card to remove
+   */
+  removeFromCache(r) {
+    this.cardCache = this.cardCache.filter((t) => t.id !== r);
+  }
+  /**
+   * Fetches cards for availale Solutions from the server.
+   *
+   * @param query AGO query terms and options
+   * @param primarySolutionsGroupId Id of a group that's the primary source of Solutions for AGO or Enterprise
+   * @param agoBasedEnterpriseSolutionsGroupId Id of an AGO-based set of Enterprise Solutions
+   * @param userSession Authentication for thumbnailUrl
+   * @param isEnterprise When true we are working with an enterprise portal
+   * @param signal AbortController signal
+   * @param pagingParams Parameters for how the request is to be batched
+   * @param acceptableIds A set of item ids that the results must be a part of; if not defined, then there's no restriction
+   * @returns A promise resolving to a collection of available Solutions as cards as well as paging information about
+   * where those cards came from in the fetcher cache; in case of failure, the promise resolves to an error message
+   */
+  requestAvailableSolutionCards(r, t, a, e, h, m, s, o) {
+    const C = s?.start ? s.start : 1, g = s?.num ? s.num : 24, R = this.portalUrl + "/sharing/rest", B = this.agolPortalUrl + "/sharing/rest", T = this.anonAgolSession, U = JSON.stringify(r.categories);
+    if (this.cardCacheParams.q !== r.q || this.cardCacheParams.categoriesAsStr !== U || r.sortField === "relevance" ? (this.cardCache = [], this.cardCacheParams = {
+      q: r.q,
+      categoriesAsStr: U,
+      sortField: r.sortField,
+      sortOrder: r.sortOrder
+    }) : (this.cardCacheParams.sortField !== r.sortField || this.cardCacheParams.sortOrder !== r.sortOrder) && (this.cardCacheParams.sortField = r.sortField, this.cardCacheParams.sortOrder = r.sortOrder, this.cardCache = p(
+      this.cardCache,
+      this.cardCacheParams.sortField,
+      this.cardCacheParams.sortOrder
+    )), this.cardCache.length > 0) {
+      let i;
+      if (o && o.size > 0) {
+        const n = A(this.cardCache, o);
+        i = d(n, C, g);
+      } else
+        i = d(this.cardCache, C, g);
+      return Promise.resolve(i);
+    }
+    const F = {
+      filter: r.filter,
+      sortField: r.sortField,
+      sortOrder: r.sortOrder,
+      categories: r?.categories ? this.convertSearchCategories(r.categories) : "",
+      signal: m
+    }, f = [];
+    if (t && !h) {
+      const i = e || new c.UserSession({});
+      f.push(
+        c.searchGroupAllContents(
+          t,
+          r.q,
+          i,
+          F,
+          R
+        )
+      );
+    }
+    return a && h && f.push(
+      c.searchGroupAllContents(
+        a,
+        r.q,
+        T,
+        F,
+        B
+      )
+    ), Promise.allSettled(f).then((i) => {
+      const n = [];
+      i.forEach((l) => {
+        if (l.status === "fulfilled") {
+          const O = l.value;
+          let S = "", w = !1;
+          S = this.agolPortalUrl, w = !0, O.results.forEach((u) => {
+            u.sourcePortalUrl = S, u.knownToBePublicSource = w;
+          }), n.push(O);
+        } else if (l.status === "rejected")
+          throw new Error(
+            l.reason.message ? l.reason.message : "cannotAccessAGO"
+            // (isPrimary
+            // // A failed fetch of the primary group in enterprise or AGO
+            // ? result.reason.message
+            // // We're in enterprise and configured to search AGO (because agoBasedEnterpriseSolutionsGroupId
+            // // is defined), but appear not to be able to reach the internet
+            // : "enterpriseCannotAccessAGO"
+            // ) as string
+          );
+      }), n.length === 0 ? this.cardCache = [] : n.length === 1 ? this.cardCache = this.getCardsFromResponse(n[0]) : this.cardCache = p(
+        this.getCardsFromResponse(this.mergeResponses(n)),
+        this.cardCacheParams.sortField,
+        this.cardCacheParams.sortOrder
+      );
+      let P;
+      if (o && o.size > 0) {
+        const l = A(this.cardCache, o);
+        P = d(l, C, g);
+      } else
+        P = d(this.cardCache, C, g);
+      return Promise.resolve(P);
+    }).catch((i) => Promise.reject(new Error(i.message)));
+  }
+  /**
+   * Fetches cards for deployed Solutions from the server.
+   *
+   * @param query AGO query terms and options
+   * @param userSession Authentication for thumbnailUrl
+   * @returns A collection of deployed Solutions as cards; the paging information shows that all of the cards
+   * are returned
+   */
+  requestDeployedSolutionCards(r, t, a = "", e) {
+    const h = this.portalUrl + "/sharing/rest";
+    if (e.aborted)
+      return Promise.resolve([]);
+    if (this.cardCacheParams.q !== r.q || this.cardCacheParams.categoriesAsStr !== JSON.stringify(r.q) || r.sortField === "relevance" ? (this.cardCache = [], this.cardCacheParams = {
+      q: r.q,
+      categoriesAsStr: "[]",
+      sortField: r.sortField,
+      sortOrder: r.sortOrder
+    }) : (this.cardCacheParams.sortField !== r.sortField || this.cardCacheParams.sortOrder !== r.sortOrder) && (this.cardCacheParams.sortField = r.sortField, this.cardCacheParams.sortOrder = r.sortOrder, this.cardCache = p(
+      this.cardCache,
+      this.cardCacheParams.sortField,
+      this.cardCacheParams.sortOrder
+    )), e.aborted)
+      return Promise.resolve([]);
+    if (this.cardCache.length > 0) {
+      const s = d(this.cardCache, 1, this.cardCache.length);
+      return Promise.resolve(s);
+    }
+    const m = {
+      q: r.q,
+      filter: r.filter,
+      sortField: r.sortField,
+      sortOrder: r.sortOrder,
+      authentication: t,
+      portal: h,
+      categories: r?.categories ? JSON.stringify(r.categories) : "",
+      num: r.num,
+      signal: e
+    };
+    return a ? c.getItemBase(a, t).then((s) => {
+      if (e.aborted)
+        return Promise.resolve([]);
+      this.cardCache = this.getCardsFromResponse({ results: [s] });
+      const o = d(this.cardCache, 1, this.cardCache.length);
+      return Promise.resolve(o);
+    }).catch((s) => Promise.reject(new Error(s))) : c.searchAllItems(m).then((s) => {
+      this.cardCache = this.getCardsFromResponse(s);
+      const o = d(this.cardCache, 1, this.cardCache.length);
+      return Promise.resolve(o);
+    }).catch((s) => Promise.reject(new Error(s)));
+  }
+  // ---------------------------------------------------------------------------------------------------------------- //
+  /**
+   * Stringifies categories for search.
+   *
+   * @param categories AGO item categories, e.g., "/Categories/Conservation"
+   * or ["/Categories/Conservation", "/Categories/Pipeline"]
+   * @returns Categories where each element is a stringified array of categories
+   */
+  convertSearchCategories(r) {
+    return r && (Array.isArray(r) ? r = r.map(
+      (t) => JSON.stringify(Array.isArray(t) ? t : [t])
+      // force to an array to allow categories with commas
+    ) : r = JSON.stringify([r])), r;
+  }
+  /**
+   * Constructs Solution cards from a Solution-query response.
+   *
+   * @param response Response from a query
+   * @returns Solution information as cards
+   */
+  getCardsFromResponse(r) {
+    return r.results.length > 0 ? c.sanitizeJSON(r.results).map(
+      (e) => {
+        const h = e.sourcePortalUrl ? e.sourcePortalUrl : this.portalUrl, m = e.sourcePortalUrl ? e.sourcePortalUrl : this.orgUrl, s = {
+          id: e.id,
+          title: e.title,
+          snippet: e.snippet || "",
+          description: e.description || "",
+          url: e.url || "",
+          itemUrl: `${m}/home/item.html` + J([{ k: "id", v: e.id }]) || "",
+          thumbnailFilename: e.thumbnail,
+          thumbnailUrl: I(
+            e.id,
+            e.thumbnail,
+            this.cMissingImageDataURI,
+            h
+          ),
+          tryitUrl: e.url || "",
+          typeKeywords: e.typeKeywords,
+          learnMoreUrl: e.properties?.learnMoreUrl || "",
+          createdMs: e.created,
+          created: b(e.created, this.locale),
+          modified: b(e.modified, this.locale),
+          numViews: e.numViews,
+          tags: e.tags,
+          categories: e.groupCategories && e.groupCategories.length > 0 ? e.groupCategories : e.categories || [],
+          licenseInfo: E(e.licenseInfo),
+          deployCommonId: v(e.typeKeywords || [], "solutionid-"),
+          deployVersion: v(e.typeKeywords || [], "solutionversion-"),
+          canDelete: e.created > 16183314e5,
+          // Only solutions deployed after April 13, 2021 at 9:30PM can be deleted (9.1 release)
+          preview: this.preparePreviewImageUrls(e.id, e.properties?.preview, h),
+          sourcePortalUrl: e.sourcePortalUrl || "",
+          knownToBePublicSource: e.knownToBePublicSource || !1,
+          waitId: "",
+          relatedSolutions: c.getProp(e, "properties.relatedSolutions") || [],
+          owner: e.owner
+        };
+        return s.deployCommonId !== "" && s.deployVersion !== "" ? s : null;
+      }
+    ).filter((e) => e != null) : [];
+  }
+  /**
+   * Merge a set of search responses into a single response item.
+   *
+   * @param responseSet Array of search results
+   * @returns A response item that takes its query from the first item in the set and sets the other properties
+   * as if all of the responses are the result of one, large query that's independent of AGO's 100-item limit.
+   */
+  mergeResponses(r) {
+    let t = 0;
+    r.forEach((e) => t += e.total);
+    let a = [];
+    return r.forEach((e) => a = a.concat(e.results)), {
+      query: r[0].query,
+      start: 1,
+      num: t,
+      nextStart: -1,
+      total: t,
+      results: a
+    };
+  }
+  /**
+   * Converts image preview information into a URL pointing to that image; returns non-image previews unchanged.
+   *
+   * @param id Item id to insert into URL
+   * @param preview List of previews to modify
+   * @returns Copy of previews with iamge previews modified
+   */
+  preparePreviewImageUrls(r, t, a) {
+    return t ? t.map(
+      (e) => (e.format === "image" && (e.name = a + "/sharing/rest/content/items/" + r + "/resources/" + e.name), e)
+    ) : [];
+  }
+}
+export {
+  M as C
+};