feat(): association group creation form and permission

packages/common/src/associations/index.ts

@@ -10,6 +10,7 @@ export * from "./getPendingEntitiesQuery";
 export * from "./getRequestingEntitiesQuery";
 export * from "./getReferencedEntityIds";
 export * from "./wellKnownAssociationCatalogs";
+export * from "./setEntityAssociationGroup";
 // Note: we expose "requestAssociation" under 2 names.
 // These actions are functionally equivalent, but we want
 // to make the intent more clear to the consumer.

packages/common/src/associations/setEntityAssociationGroup.ts

@@ -0,0 +1,47 @@
+import { IArcGISContext } from "../ArcGISContext";
+import { IHubGroup, getTypeFromEntity } from "../core";
+import { HubEntity } from "../core/types/HubEntity";
+import { updateHubEntity } from "../core/updateHubEntity";
+import { setProp } from "../objects";
+
+/**
+ * Utility to create a relationship between an entity and a group, setting the group as
+ * the entity's association group. This adds the entity-specific association keyword to the association group,
+ * and it adds the association definition to the original entity.
+ * @param entity
+ * @param group
+ * @param context
+ * @returns
+ */
+export async function setEntityAssociationGroup(
+  entity: HubEntity,
+  group: IHubGroup,
+  context: IArcGISContext
+): Promise<HubEntity> {
+  const type = getTypeFromEntity(entity);
+
+  // 1. Add the association marker to the group entity
+  // if we don't already have it
+  const associationKeyword = `${type}|${entity.id}`;
+  if (!group.typeKeywords.includes(associationKeyword)) {
+    group.typeKeywords = [...group.typeKeywords, `${type}|${entity.id}`];
+  }
+
+  await updateHubEntity("group", group, context);
+
+  // 2. construct and persist the initiative's association definition
+  const associations = {
+    groupId: group.id,
+    rules: {
+      schemaVersion: 1,
+      query: {
+        targetEntity: "item",
+        filters: [{ predicates: [{ group: group.id }] }],
+      },
+    },
+  };
+  setProp("associations", associations, entity);
+  const updatedEntity = await updateHubEntity(type, entity, context);
+
+  return updatedEntity;
+}

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

@@ -9,6 +9,7 @@ import { filterSchemaToUiSchema } from "./filterSchemaToUiSchema";
 import { CardEditorOptions } from "./EditorOptions";
 import { cloneObject } from "../../../util";
 import { IArcGISContext } from "../../../ArcGISContext";
+import { ICardEditorModuleType } from "../types";
 
 /**
  * get the editor schema and uiSchema defined for a layout card.
@@ -36,6 +37,7 @@ export async function getCardEditorSchemas(
   let uiSchema;
   let schemaPromise;
   let uiSchemaPromise;
+  let defaults;
 
   switch (cardType) {
     case "stat":
@@ -55,8 +57,19 @@ export async function getCardEditorSchemas(
             options,
             context
           );
+
+          // if we have buildDefaults, build the defaults
+          // TODO: when first implementing buildDefaults for initiative templates, remove the ignore line
+
+          /* istanbul ignore next */
+          if ((uiSchemaModuleResolved as ICardEditorModuleType).buildDefaults) {
+            defaults = (
+              uiSchemaModuleResolved as ICardEditorModuleType
+            ).buildDefaults(i18nScope, options, context);
+          }
         }
       );
+
       break;
     case "follow":
       // get correct module

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

@@ -5,6 +5,8 @@ import {
   IConfigurationSchema,
   IUiSchema,
   IEditorConfig,
+  IConfigurationValues,
+  IEntityEditorModuleType,
 } from "../types";
 import { filterSchemaToUiSchema } from "./filterSchemaToUiSchema";
 import { SiteEditorType } from "../../../sites/_internal/SiteSchema";
@@ -46,14 +48,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": () =>
@@ -71,6 +74,18 @@ export async function getEditorSchemas(
         context
       );
 
+      // if we have the buildDefaults fn, then construct the defaults
+      // TODO: when implementing buildDefaults for sites, remove the ignore line
+
+      /* istanbul ignore next */
+      if (siteModule.buildDefaults) {
+        defaults = await siteModule.buildDefaults(
+          i18nScope,
+          options as EntityEditorOptions,
+          context
+        );
+      }
+
       break;
     // ----------------------------------------------------
     case "discussion":
@@ -79,7 +94,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": () =>
@@ -93,6 +108,18 @@ export async function getEditorSchemas(
         context
       );
 
+      // if we have the buildDefaults fn, then construct the defaults
+      // TODO: when first implementing buildDefaults for discussions, remove the ignore line
+
+      /* istanbul ignore next */
+      if (discussionModule.buildDefaults) {
+        defaults = await discussionModule.buildDefaults(
+          i18nScope,
+          options as EntityEditorOptions,
+          context
+        );
+      }
+
       break;
     // ----------------------------------------------------
     case "project":
@@ -101,7 +128,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": () =>
@@ -114,6 +141,18 @@ export async function getEditorSchemas(
         context
       );
 
+      // if we have the buildDefaults fn, then construct the defaults
+      // TODO: when first implementing buildDefaults for projects, remove the ignore line
+
+      /* istanbul ignore next */
+      if (projectModule.buildDefaults) {
+        defaults = await projectModule.buildDefaults(
+          i18nScope,
+          options as EntityEditorOptions,
+          context
+        );
+      }
+
       break;
     // ----------------------------------------------------
     case "initiative":
@@ -122,7 +161,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": () =>
@@ -134,6 +173,18 @@ export async function getEditorSchemas(
         context
       );
 
+      // if we have the buildDefaults fn, then construct the defaults
+      // TODO: when first implementing buildDefaults for initiatives, remove the ignore line
+
+      /* istanbul ignore next */
+      if (initiativeModule.buildDefaults) {
+        defaults = await initiativeModule.buildDefaults(
+          i18nScope,
+          options as EntityEditorOptions,
+          context
+        );
+      }
+
       break;
     // ----------------------------------------------------
     case "page":
@@ -142,7 +193,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]();
@@ -152,6 +203,18 @@ export async function getEditorSchemas(
         context
       );
 
+      // if we have the buildDefaults fn, then construct the defaults
+      // TODO: when first implementing buildDefaults for pages, remove the ignore line
+
+      /* istanbul ignore next */
+      if (pageModule.buildDefaults) {
+        defaults = await pageModule.buildDefaults(
+          i18nScope,
+          options as EntityEditorOptions,
+          context
+        );
+      }
+
       break;
     // ----------------------------------------------------
     case "content":
@@ -160,7 +223,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": () =>
@@ -174,6 +237,18 @@ export async function getEditorSchemas(
         context
       );
 
+      // if we have the buildDefaults fn, then construct the defaults
+      // TODO: when first implementing buildDefaults for content, remove the ignore line
+
+      /* istanbul ignore next */
+      if (contentModule.buildDefaults) {
+        defaults = await contentModule.buildDefaults(
+          i18nScope,
+          options as EntityEditorOptions,
+          context
+        );
+      }
+
       break;
     // ----------------------------------------------------
     case "template":
@@ -182,7 +257,7 @@ export async function getEditorSchemas(
       );
       schema = cloneObject(TemplateSchema);
 
-      const templateModule = await {
+      const templateModule: IEntityEditorModuleType = await {
         "hub:template:edit": () =>
           import("../../../templates/_internal/TemplateUiSchemaEdit"),
       }[type as TemplateEditorType]();
@@ -192,6 +267,18 @@ export async function getEditorSchemas(
         context
       );
 
+      // if we have the buildDefaults fn, then construct the defaults
+      // TODO: when first implementing buildDefaults for templates, remove the ignore line
+
+      /* istanbul ignore next */
+      if (templateModule.buildDefaults) {
+        defaults = await templateModule.buildDefaults(
+          i18nScope,
+          options as EntityEditorOptions,
+          context
+        );
+      }
+
       break;
     // ----------------------------------------------------
     case "group":
@@ -200,9 +287,11 @@ export async function getEditorSchemas(
       );
       schema = cloneObject(GroupSchema);
 
-      const groupModule = await {
+      const groupModule: IEntityEditorModuleType = 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 +309,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: IEntityEditorModuleType = await {
         "hub:initiativeTemplate:edit": () =>
           import(
             "../../../initiative-templates/_internal/InitiativeTemplateUiSchemaEdit"
@@ -240,6 +338,18 @@ export async function getEditorSchemas(
         context
       );
 
+      // if we have the buildDefaults fn, then construct the defaults
+      // TODO: when first implementing buildDefaults for initiative templates, remove the ignore line
+
+      /* istanbul ignore next */
+      if (initiativeTemplateModule.buildDefaults) {
+        defaults = await initiativeTemplateModule.buildDefaults(
+          i18nScope,
+          options as EntityEditorOptions,
+          context
+        );
+      }
+
       break;
 
     case "card":
@@ -251,10 +361,11 @@ export async function getEditorSchemas(
       );
       schema = result.schema;
       uiSchema = result.uiSchema;
+      defaults = result.defaults;
   }
 
   // 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: [