feat: showInfoBanner for user org settings (#1676)

Esri · Oct 4, 2024 · ee32bb6 · ee32bb6
1 parent d840653
commit ee32bb6
Show file tree

Hide file tree

Showing 8 changed files with 415 additions and 51 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/common/src/users/HubUser.ts b/packages/common/src/users/HubUser.ts
@@ -8,6 +8,7 @@ import { cloneObject } from "../util";
 import { UserEditorType } from "./_internal/UserSchema";
 import { DEFAULT_USER } from "./defaults";
 import { updateCommunityOrgSettings } from "../utils/internal/updateCommunityOrgSettings";
+import { updatePortalOrgSettings } from "../utils/internal/updatePortalOrgSettings";
 
 export class HubUser implements IWithEditorBehavior {
   protected context: IArcGISContext;
@@ -92,7 +93,15 @@ export class HubUser implements IWithEditorBehavior {
     }
 
     // 3. update portal settings
-    // TODO in later story
+    // User is org admin, we have org settings to send, and we have a banner to show
+    if (
+      this.context.isOrgAdmin &&
+      this.entity.hubOrgSettings &&
+      this.entity.hubOrgSettings.hasOwnProperty("showInformationalBanner")
+    ) {
+      // update the portal settings
+      await updatePortalOrgSettings(this.entity.hubOrgSettings, this.context);
+    }
 
     return;
   }

diff --git a/packages/common/src/users/_internal/UserUiSchemaSettings.ts b/packages/common/src/users/_internal/UserUiSchemaSettings.ts
@@ -123,6 +123,26 @@ export const buildUiSchema = async (
               },
             },
           },
+          {
+            type: "Section",
+            labelKey: `${i18nScope}.sections.orgSettings.siteDefaults.label`,
+            elements: [
+              {
+                type: "Control",
+                scope:
+                  "/properties/hubOrgSettings/properties/showInformationalBanner",
+                labelKey: `${i18nScope}.fields.infoBanner.label`,
+                options: {
+                  type: "Control",
+                  control: "hub-field-input-switch",
+                  layout: "inline-space-between",
+                  helperText: {
+                    labelKey: `${i18nScope}.fields.infoBanner.helperText`,
+                  },
+                },
+              },
+            ],
+          },
           {
             type: "Section",
             labelKey: `${i18nScope}.sections.orgSettings.signinSettings.label`,

diff --git a/packages/common/src/utils/internal/updateCommunityOrgSettings.ts b/packages/common/src/utils/internal/updateCommunityOrgSettings.ts
@@ -1,4 +1,3 @@
-import { _isOrgAdmin, getPortalUrl } from "../..";
 import { IArcGISContext } from "../../ArcGISContext";
 import { IHubUserOrgSettings } from "../../core/types/IHubUser";
 import { request } from "@esri/arcgis-rest-request";

diff --git a/packages/common/src/utils/internal/updatePortalOrgSettings.ts b/packages/common/src/utils/internal/updatePortalOrgSettings.ts
@@ -0,0 +1,44 @@
+import { IArcGISContext } from "../../ArcGISContext";
+import { IHubUserOrgSettings } from "../../core/types/IHubUser";
+import { request } from "@esri/arcgis-rest-request";
+import { cloneObject } from "../../util";
+
+/**
+ * Function to update a user's org settings. Expects the user to be an org admin in the current org.
+ * Currently only updates whether to show the informational banner.
+ * @param settings
+ */
+export async function updatePortalOrgSettings(
+  settings: IHubUserOrgSettings,
+  context: IArcGISContext
+) {
+  // check that user is authed
+  if (!context.currentUser) {
+    throw new Error("User is not authenticated");
+  }
+
+  // check that user is org admin
+  if (!context.isOrgAdmin) {
+    throw new Error("User is not an org admin in the current org");
+  }
+
+  // grab and clone portalProperties
+  const portalProperties = cloneObject(context.portal.portalProperties);
+  // grab settings
+  const { showInformationalBanner } = settings;
+  // update infoBanner value in portalProperties
+  portalProperties.hub.settings.informationalBanner = showInformationalBanner;
+
+  // build the url
+  const urlPath = `/sharing/rest/portals/self/update?f=json`;
+  const url = `${context.portalUrl}${urlPath}`;
+
+  // send the request to update
+  return request(url, {
+    httpMethod: "POST",
+    params: {
+      portalProperties: JSON.stringify(portalProperties),
+      token: context.hubRequestOptions.authentication.token,
+    },
+  });
+}