feat(): association group creation form and permission

packages/common/src/core/schemas/internal/getEditorSchemas.ts

@@ -5,6 +5,9 @@ import {
   IConfigurationSchema,
   IUiSchema,
   IEditorConfig,
+  IConfigurationValues,
+  IEditorModuleType,
+  IEntityEditorModuleType,
 } from "../types";
 import { filterSchemaToUiSchema } from "./filterSchemaToUiSchema";
 import { SiteEditorType } from "../../../sites/_internal/SiteSchema";
@@ -46,14 +49,15 @@ export async function getEditorSchemas(
   // the entity type and the provided editor type
   let schema: IConfigurationSchema;
   let uiSchema: IUiSchema;
+  let defaults: IConfigurationValues;
   switch (editorType) {
     case "site":
       const { SiteSchema } = await import(
         "../../../sites/_internal/SiteSchema"
       );
       schema = cloneObject(SiteSchema);
 
-      const siteModule = await {
+      const siteModule: IEntityEditorModuleType = await {
         "hub:site:edit": () =>
           import("../../../sites/_internal/SiteUiSchemaEdit"),
         "hub:site:create": () =>
@@ -79,7 +83,7 @@ export async function getEditorSchemas(
       );
       schema = cloneObject(DiscussionSchema);
 
-      const discussionModule = await {
+      const discussionModule: IEntityEditorModuleType = await {
         "hub:discussion:edit": () =>
           import("../../../discussions/_internal/DiscussionUiSchemaEdit"),
         "hub:discussion:create": () =>
@@ -101,7 +105,7 @@ export async function getEditorSchemas(
       );
       schema = cloneObject(ProjectSchema);
 
-      const projectModule = await {
+      const projectModule: IEntityEditorModuleType = await {
         "hub:project:edit": () =>
           import("../../../projects/_internal/ProjectUiSchemaEdit"),
         "hub:project:create": () =>
@@ -122,7 +126,7 @@ export async function getEditorSchemas(
       );
       schema = cloneObject(InitiativeSchema);
 
-      const initiativeModule = await {
+      const initiativeModule: IEntityEditorModuleType = await {
         "hub:initiative:edit": () =>
           import("../../../initiatives/_internal/InitiativeUiSchemaEdit"),
         "hub:initiative:create": () =>
@@ -142,7 +146,7 @@ export async function getEditorSchemas(
       );
       schema = cloneObject(PageSchema);
 
-      const pageModule = await {
+      const pageModule: IEntityEditorModuleType = await {
         "hub:page:edit": () =>
           import("../../../pages/_internal/PageUiSchemaEdit"),
       }[type as PageEditorType]();
@@ -160,7 +164,7 @@ export async function getEditorSchemas(
       );
       schema = cloneObject(ContentSchema);
 
-      const contentModule = await {
+      const contentModule: IEntityEditorModuleType = await {
         "hub:content:edit": () =>
           import("../../../content/_internal/ContentUiSchemaEdit"),
         "hub:content:discussions": () =>
@@ -182,7 +186,7 @@ export async function getEditorSchemas(
       );
       schema = cloneObject(TemplateSchema);
 
-      const templateModule = await {
+      const templateModule: IEditorModuleType = await {
         "hub:template:edit": () =>
           import("../../../templates/_internal/TemplateUiSchemaEdit"),
       }[type as TemplateEditorType]();
@@ -200,9 +204,11 @@ export async function getEditorSchemas(
       );
       schema = cloneObject(GroupSchema);
 
-      const groupModule = await {
+      const groupModule: IEditorModuleType = await {
         "hub:group:create:followers": () =>
           import("../../../groups/_internal/GroupUiSchemaCreateFollowers"),
+        "hub:group:create:association": () =>
+          import("../../../groups/_internal/GroupUiSchemaCreateAssociation"),
         "hub:group:create:view": () =>
           import("../../../groups/_internal/GroupUiSchemaCreateView"),
         "hub:group:create:edit": () =>
@@ -220,14 +226,23 @@ export async function getEditorSchemas(
         context
       );
 
+      // if we have the buildDefaults fn, then construct the defaults
+      if (groupModule.buildDefaults) {
+        defaults = await groupModule.buildDefaults(
+          i18nScope,
+          options as EntityEditorOptions,
+          context
+        );
+      }
+
       break;
 
     case "initiativeTemplate":
       const { InitiativeTemplateSchema } = await import(
         "../../../initiative-templates/_internal/InitiativeTemplateSchema"
       );
       schema = cloneObject(InitiativeTemplateSchema);
-      const initiativeTemplateModule = await {
+      const initiativeTemplateModule: IEditorModuleType = await {
         "hub:initiativeTemplate:edit": () =>
           import(
             "../../../initiative-templates/_internal/InitiativeTemplateUiSchemaEdit"
@@ -256,5 +271,5 @@ export async function getEditorSchemas(
   // filter out properties not used in the UI schema
   schema = filterSchemaToUiSchema(schema, uiSchema);
 
-  return Promise.resolve({ schema, uiSchema });
+  return Promise.resolve({ schema, uiSchema, defaults });
 }

packages/common/src/core/schemas/internal/metrics/ProjectUiSchemaMetrics.ts

@@ -18,11 +18,11 @@ import {
  * @param context
  * @returns
  */
-export const buildUiSchema = (
+export const buildUiSchema = async (
   i18nScope: string,
   config: EntityEditorOptions,
   context: IArcGISContext
-): IUiSchema => {
+): Promise<IUiSchema> => {
   return {
     type: "Layout",
     elements: [

packages/common/src/core/schemas/internal/metrics/StatCardUiSchema.ts

@@ -7,11 +7,11 @@ import { UiSchemaRuleEffects, IUiSchema } from "../../types";
  * Exports the uiSchema of the stat card
  * @returns
  */
-export const buildUiSchema = (
+export const buildUiSchema = async (
   i18nScope: string,
   config: IStatCardEditorOptions,
   context: IArcGISContext
-): IUiSchema => {
+): Promise<IUiSchema> => {
   const { themeColors } = config;
   return {
     type: "Layout",

packages/common/src/core/schemas/types.ts

@@ -10,10 +10,16 @@ import { ContentEditorTypes } from "../../content/_internal/ContentSchema";
 import { TemplateEditorTypes } from "../../templates/_internal/TemplateSchema";
 import { GroupEditorTypes } from "../../groups/_internal/GroupSchema";
 import { InitiativeTemplateEditorTypes } from "../../initiative-templates/_internal/InitiativeTemplateSchema";
+import {
+  CardEditorOptions,
+  EntityEditorOptions,
+} from "./internal/EditorOptions";
+import { IArcGISContext } from "../../ArcGISContext";
 
 export interface IEditorConfig {
   schema: IConfigurationSchema;
   uiSchema: IUiSchema;
+  defaults?: IConfigurationValues;
 }
 
 /**
@@ -67,6 +73,50 @@ export const validEditorTypes = [
   ...validCardEditorTypes,
 ] as const;
 
+/**
+ * An editor's module when dynamically imported depending on the EditorType. This
+ * will always have a buildUiSchema function, and sometimes it will have a
+ * buildDefaults function to override default values in the editor.
+ */
+export type IEditorModuleType = IEntityEditorModuleType | ICardEditorModuleType;
+
+/**
+ * An entity editor's module when dynamically imported depending on the EditorType. This
+ * will always have a buildUiSchema function, and sometimes it will have a
+ * buildDefaults function to override default values in the editor.
+ */
+export interface IEntityEditorModuleType {
+  buildUiSchema: (
+    i18nScope: string,
+    options: EntityEditorOptions,
+    context: IArcGISContext
+  ) => Promise<IUiSchema>;
+  buildDefaults?: (
+    i18nScope: string,
+    options: EntityEditorOptions,
+    context: IArcGISContext
+  ) => Promise<IConfigurationValues>;
+}
+
+/**
+ * A card editor's module when dynamically imported depending on the EditorType. This
+ * will always have a buildUiSchema function, and sometimes it will have a
+ * buildDefaults function to override default values in the editor.
+ */
+export interface ICardEditorModuleType {
+  buildUiSchema: (
+    i18nScope: string,
+    config: CardEditorOptions,
+    context: IArcGISContext
+  ) => Promise<IUiSchema>;
+
+  buildDefaults?: (
+    i18nScope: string,
+    options: CardEditorOptions,
+    context: IArcGISContext
+  ) => Promise<IConfigurationValues>;
+}
+
 export enum UiSchemaRuleEffects {
   SHOW = "SHOW",
   HIDE = "HIDE",

packages/common/src/groups/_internal/GroupSchema.ts

@@ -13,6 +13,8 @@ export const GroupEditorTypes = [
   "hub:group:discussions",
   // editor to create a followers group
   "hub:group:create:followers",
+  // editor to create an association group
+  "hub:group:create:association",
   "hub:group:create:view",
   "hub:group:create:edit",
 ] as const;

packages/common/src/groups/_internal/GroupUiSchemaCreateAssociation.ts

@@ -0,0 +1,132 @@
+import {
+  IConfigurationValues,
+  IUiSchema,
+  UiSchemaRuleEffects,
+} from "../../core/schemas/types";
+import { IArcGISContext } from "../../ArcGISContext";
+import { EntityEditorOptions } from "../../core/schemas/internal/EditorOptions";
+import { getWellKnownGroup } from "../getWellKnownGroup";
+
+/**
+ * @private
+ * constructs the complete uiSchema for creating an association
+ * group. This defines how the schema properties should be
+ * rendered in the association group creation experience
+ */
+export const buildUiSchema = async (
+  i18nScope: string,
+  options: EntityEditorOptions,
+  context: IArcGISContext
+): Promise<IUiSchema> => {
+  return {
+    type: "Layout",
+    elements: [
+      {
+        type: "Section",
+        options: { section: "stepper", scale: "l" },
+        elements: [
+          {
+            type: "Section",
+            labelKey: `${i18nScope}.sections.details.label`,
+            options: {
+              section: "step",
+            },
+            elements: [
+              {
+                labelKey: `${i18nScope}.fields.name.label`,
+                scope: "/properties/name",
+                type: "Control",
+                options: {
+                  messages: [
+                    {
+                      type: "ERROR",
+                      keyword: "required",
+                      icon: true,
+                      labelKey: `${i18nScope}.fields.name.requiredError`,
+                    },
+                    {
+                      type: "ERROR",
+                      keyword: "maxLength",
+                      icon: true,
+                      labelKey: `${i18nScope}.fields.name.maxLengthError`,
+                    },
+                  ],
+                },
+              },
+              {
+                labelKey: `${i18nScope}.fields.summary.label`,
+                scope: "/properties/summary",
+                type: "Control",
+                options: {
+                  control: "hub-field-input-input",
+                  type: "textarea",
+                  rows: 4,
+                  messages: [
+                    {
+                      type: "ERROR",
+                      keyword: "maxLength",
+                      icon: true,
+                      labelKey: `${i18nScope}.fields.summary.maxLengthError`,
+                    },
+                  ],
+                },
+              },
+            ],
+          },
+          {
+            type: "Section",
+            labelKey: `${i18nScope}.sections.membershipAccess.label`,
+            options: {
+              section: "step",
+            },
+            rule: {
+              effect: UiSchemaRuleEffects.DISABLE,
+              condition: {
+                scope: "/properties/name",
+                schema: { const: "" },
+              },
+            },
+            elements: [
+              {
+                labelKey: `${i18nScope}.fields.membershipAccess.label`,
+                scope: "/properties/membershipAccess",
+                type: "Control",
+                options: {
+                  control: "hub-field-input-radio",
+                  labels: [
+                    `{{${i18nScope}.fields.membershipAccess.org:translate}}`,
+                    `{{${i18nScope}.fields.membershipAccess.collab:translate}}`,
+                    `{{${i18nScope}.fields.membershipAccess.createAssociation.any:translate}}`,
+                  ],
+                  disabled: [false, false, options.isSharedUpdate],
+                },
+              },
+              {
+                labelKey: `${i18nScope}.fields.contributeContent.label`,
+                scope: "/properties/isViewOnly",
+                type: "Control",
+                options: {
+                  control: "hub-field-input-radio",
+                  labels: [
+                    `{{${i18nScope}.fields.contributeContent.all:translate}}`,
+                    `{{${i18nScope}.fields.contributeContent.createAssociation.admins:translate}}`,
+                  ],
+                },
+              },
+            ],
+          },
+        ],
+      },
+    ],
+  };
+};
+
+export const buildDefaults = async (
+  i18nScope: string,
+  options: EntityEditorOptions,
+  context: IArcGISContext
+): Promise<IConfigurationValues> => {
+  return {
+    ...getWellKnownGroup("hubAssociationsGroup", context),
+  };
+};