feat(hub-common): update channel ui schemas to use noticeIds rather than manual notice definitions

affects: @esri/hub-common

ISSUES CLOSED: 12468

Author: rweber-esri

packages/common/src/channels/HubChannel.ts

@@ -150,11 +150,11 @@ export class HubChannel
       throw new Error("HubChannel is already destroyed.");
     }
 
-    const { updateHubChannel, createHubChannel } = await import("./edit");
-
     if (this.entity.id) {
+      const { updateHubChannel } = await import("./edit");
       this.entity = await updateHubChannel(this.entity, this.context);
     } else {
+      const { createHubChannel } = await import("./edit");
       this.entity = await createHubChannel(this.entity, this.context);
     }
   }

packages/common/src/channels/_internal/ChannelUiSchemaCreate.ts

@@ -143,24 +143,7 @@ export const buildUiSchema = async (
           {
             type: "Notice",
             options: {
-              notice: {
-                configuration: {
-                  noticeType: "notice",
-                  closable: false,
-                  kind: "info",
-                  scale: "m",
-                },
-                title: `{{${i18nScope}.sections.permissions.notice.title:translate}}`,
-                message: `{{${i18nScope}.sections.permissions.notice.message:translate}}`,
-                autoShow: true,
-                actions: [
-                  {
-                    label: `{{${i18nScope}.sections.permissions.notice.action:translate}}`,
-                    href: "#readMore",
-                    target: "_blank",
-                  },
-                ],
-              },
+              noticeId: "20250311-channel-permissions-info",
             },
           },
           {

packages/common/src/channels/_internal/ChannelUiSchemaEdit.ts

@@ -14,6 +14,13 @@ export const buildUiSchema = async (
   options: Partial<IHubChannel>,
   context: IArcGISContext
 ): Promise<IUiSchema> => {
-  // the create and edit schemas are the same at this time, this leaves the door open for them to change over time
-  return buildUiSchemaCreate(i18nScope, options, context);
+  const uiSchema = await buildUiSchemaCreate(i18nScope, options, context);
+  // the create and edit schemas are the same with the exception of the edit notice
+  uiSchema.elements.splice(0, 0, {
+    type: "Notice",
+    options: {
+      noticeId: "20250311-channel-edit-warning",
+    },
+  });
+  return uiSchema;
 };

packages/common/test/channels/_internal/ChannelUiSchemaCreate.test.ts

@@ -109,24 +109,7 @@ describe("ChannelUiSchemaCreate", () => {
               {
                 type: "Notice",
                 options: {
-                  notice: {
-                    configuration: {
-                      noticeType: "notice",
-                      closable: false,
-                      kind: "info",
-                      scale: "m",
-                    },
-                    title: `{{${i18nScope}.sections.permissions.notice.title:translate}}`,
-                    message: `{{${i18nScope}.sections.permissions.notice.message:translate}}`,
-                    autoShow: true,
-                    actions: [
-                      {
-                        label: `{{${i18nScope}.sections.permissions.notice.action:translate}}`,
-                        href: "#readMore",
-                        target: "_blank",
-                      },
-                    ],
-                  },
+                  noticeId: "20250311-channel-permissions-info",
                 },
               },
               {
@@ -403,24 +386,7 @@ describe("ChannelUiSchemaCreate", () => {
               {
                 type: "Notice",
                 options: {
-                  notice: {
-                    configuration: {
-                      noticeType: "notice",
-                      closable: false,
-                      kind: "info",
-                      scale: "m",
-                    },
-                    title: `{{${i18nScope}.sections.permissions.notice.title:translate}}`,
-                    message: `{{${i18nScope}.sections.permissions.notice.message:translate}}`,
-                    autoShow: true,
-                    actions: [
-                      {
-                        label: `{{${i18nScope}.sections.permissions.notice.action:translate}}`,
-                        href: "#readMore",
-                        target: "_blank",
-                      },
-                    ],
-                  },
+                  noticeId: "20250311-channel-permissions-info",
                 },
               },
               {

packages/common/test/channels/_internal/ChannelUiSchemaEdit.test.ts

@@ -16,13 +16,25 @@ describe("ChannelUiSchemaEdit", () => {
     } as unknown as IArcGISContext;
 
     it("should return the schema from buildUiSchemaCreate", async () => {
-      const expected: IUiSchema = {
+      const createSchema: IUiSchema = {
         type: "Layout",
+        elements: [],
       };
       const buildUiSchemaCreateSpy = spyOn(
         ChannelUiSchemaCreateModule,
         "buildUiSchema"
-      ).and.returnValue(expected);
+      ).and.returnValue(createSchema);
+      const expected: IUiSchema = {
+        ...createSchema,
+        elements: [
+          {
+            type: "Notice",
+            options: {
+              noticeId: "20250311-channel-edit-warning",
+            },
+          },
+        ],
+      };
       const result = await buildUiSchema(i18nScope, options, context);
       expect(result).toEqual(expected);
       expect(buildUiSchemaCreateSpy).toHaveBeenCalledTimes(1);