feat(hub-common): add support for configuring entity references for E… (

#1611)
Esri · Sep 12, 2024 · 9435382 · 9435382
1 parent 31fb3ea
commit 9435382
Show file tree

Hide file tree

Showing 28 changed files with 905 additions and 417 deletions.
diff --git a/packages/common/src/core/schemas/internal/events/EventGalleryCardSchema.ts b/packages/common/src/core/schemas/internal/events/EventGalleryCardSchema.ts
@@ -28,8 +28,8 @@ export const EventGalleryCardSchema: IConfigurationSchema = {
     },
     corners: {
       type: "string",
-      enum: ["squared", "rounded"],
-      default: "squared",
+      enum: ["square", "round"],
+      default: "square",
     },
     shadow: {
       type: "string",

diff --git a/packages/common/src/core/types/IHubEvent.ts b/packages/common/src/core/types/IHubEvent.ts
@@ -158,9 +158,14 @@ export interface IHubEvent
   readGroupIds: string[];
 
   /**
-   * A collection of objects containing the ids & types for entities that the event references
+   * A collection of content ids explicitly referenced by the event
    */
-  references: Array<Record<string, string>>;
+  referencedContentIds: string[];
+
+  /**
+   * A collection of objects containing the ids & types for entities referenced by the event
+   */
+  referencedContentIdsByType: Array<{ entityId: string; entityType: string }>;
 
   /**
    * The start date of the event

diff --git a/packages/common/src/events/_internal/EventSchemaCreate.ts b/packages/common/src/events/_internal/EventSchemaCreate.ts
@@ -51,6 +51,14 @@ export const buildSchema = (): IConfigurationSchema => {
       onlineUrl: {
         type: "string",
       },
+      referencedContentIds: {
+        type: "array",
+        maxItems: 1,
+        items: {
+          type: "string",
+        },
+        default: [],
+      },
     },
     allOf: [
       URL_VALIDATIONS_WHEN_ONLINE_OR_HYBRID,

diff --git a/packages/common/src/events/_internal/EventSchemaEdit.ts b/packages/common/src/events/_internal/EventSchemaEdit.ts
@@ -12,14 +12,12 @@ import {
   FIXED_ONLINE_ATTENDANCE_VALIDATIONS,
   FIXED_IN_PERSON_ATTENDANCE_VALIDATIONS,
 } from "./validations";
-import { getDefaultEventDatesAndTimes } from "./getDefaultEventDatesAndTimes";
 
 /**
  * @private
  * Builds a schema for creating a new Event that enforces a startDate relative to the user's locale
  */
 export const buildSchema = (): IConfigurationSchema => {
-  const { startDate: minStartDate } = getDefaultEventDatesAndTimes();
   return {
     required: ["name", "startDate", "endDate", "timeZone"],
     properties: {
@@ -85,6 +83,14 @@ export const buildSchema = (): IConfigurationSchema => {
         enum: [HubEventCapacityType.Unlimited, HubEventCapacityType.Fixed],
         default: HubEventCapacityType.Unlimited,
       },
+      referencedContentIds: {
+        type: "array",
+        maxItems: 1,
+        items: {
+          type: "string",
+        },
+        default: [],
+      },
       summary: ENTITY_SUMMARY_SCHEMA,
       tags: ENTITY_TAGS_SCHEMA,
       categories: ENTITY_CATEGORIES_SCHEMA,

diff --git a/packages/common/src/events/_internal/EventUiSchemaCreate.ts b/packages/common/src/events/_internal/EventUiSchemaCreate.ts
@@ -4,6 +4,7 @@ import { EntityEditorOptions } from "../../core/schemas/internal/EditorOptions";
 import { getDatePickerDate } from "../../utils/date/getDatePickerDate";
 import { IHubEvent } from "../../core/types/IHubEvent";
 import { HubEventAttendanceType } from "../types";
+import { buildReferencedContentSchema } from "./buildReferencedContentSchema";
 
 /**
  * @private
@@ -170,6 +171,11 @@ export const buildUiSchema = async (
           ],
         },
       },
+      buildReferencedContentSchema(
+        i18nScope,
+        context,
+        `{{${i18nScope}.fields.referencedContent.label:translate}}`
+      ),
     ],
   };
 };
diff --git a/packages/common/src/events/_internal/EventUiSchemaEdit.ts b/packages/common/src/events/_internal/EventUiSchemaEdit.ts
@@ -1,12 +1,13 @@
 import { IUiSchema, UiSchemaRuleEffects } from "../../core/schemas/types";
 import { IArcGISContext } from "../../ArcGISContext";
-import { getDatePickerDate } from "../../utils/date/getDatePickerDate";
 import { IHubEvent } from "../../core/types/IHubEvent";
 import { getTagItems } from "../../core/schemas/internal/getTagItems";
 import { HubEventAttendanceType, HubEventCapacityType } from "../types";
 import { getLocationExtent } from "../../core/schemas/internal/getLocationExtent";
 import { getLocationOptions } from "../../core/schemas/internal/getLocationOptions";
 import { fetchCategoriesUiSchemaElement } from "../../core/schemas/internal/fetchCategoriesUiSchemaElement";
+import { getWellKnownCatalog } from "../../search/wellKnownCatalog";
+import { buildReferencedContentSchema } from "./buildReferencedContentSchema";
 
 /**
  * @private
@@ -19,10 +20,6 @@ export const buildUiSchema = async (
   options: Partial<IHubEvent>,
   context: IArcGISContext
 ): Promise<IUiSchema> => {
-  const minStartEndDate = getDatePickerDate(
-    new Date(),
-    (options as IHubEvent).timeZone
-  );
   return {
     type: "Layout",
     elements: [
@@ -401,6 +398,11 @@ export const buildUiSchema = async (
           },
         ],
       },
+      {
+        type: "Section",
+        labelKey: `${i18nScope}.sections.referencedContent.label`,
+        elements: [buildReferencedContentSchema(i18nScope, context)],
+      },
       {
         type: "Section",
         labelKey: `${i18nScope}.sections.discoverability.label`,

diff --git a/packages/common/src/events/_internal/PropertyMapper.ts b/packages/common/src/events/_internal/PropertyMapper.ts
@@ -83,6 +83,12 @@ export class EventPropertyMapper extends PropertyMapper<
       store.permission.canSetStatusToCancelled,
       store.permission.canSetStatusToRemoved,
     ].some(Boolean);
+    obj.referencedContentIds = store.associations.map(
+      ({ entityId }) => entityId
+    );
+    obj.referencedContentIdsByType = store.associations.map(
+      ({ entityId, entityType }) => ({ entityId, entityType })
+    );
 
     // Handle Dates
     obj.createdDate = new Date(store.createdAt);

diff --git a/packages/common/src/events/_internal/buildEventAssociations.ts b/packages/common/src/events/_internal/buildEventAssociations.ts
@@ -0,0 +1,34 @@
+import { IHubRequestOptions } from "../../types";
+import { ICreateEventAssociation } from "../api";
+import { searchItems } from "@esri/arcgis-rest-portal";
+
+export async function buildEventAssociations(
+  referencedContentIdsByType: Array<{ entityId: string; entityType: string }>,
+  referencedContentIds: string[],
+  hubRequestOptions: IHubRequestOptions
+): Promise<ICreateEventAssociation[]> {
+  // filter out content that was removed
+  const associations = referencedContentIdsByType.filter(({ entityId }) =>
+    referencedContentIds.includes(entityId)
+  );
+  // get content ids being added
+  const added = referencedContentIds.filter(
+    (referencedContentId) =>
+      !associations.find(({ entityId }) => entityId === referencedContentId)
+  );
+  if (added.length) {
+    // fetch the content being added
+    const { results } = await searchItems({
+      q: added.map((id) => `id:${id}`).join(" OR "),
+      num: added.length,
+      authentication: hubRequestOptions.authentication,
+    });
+    // map content to ICreateEventAssociation structures
+    const addedAssociations = results.map(({ id, type }) => ({
+      entityId: id,
+      entityType: type,
+    }));
+    associations.push(...addedAssociations);
+  }
+  return associations as ICreateEventAssociation[];
+}
diff --git a/packages/common/src/events/_internal/buildReferencedContentSchema.ts b/packages/common/src/events/_internal/buildReferencedContentSchema.ts
@@ -0,0 +1,72 @@
+import { IArcGISContext } from "../../ArcGISContext";
+import { IUiSchemaElement } from "../../core/schemas/types";
+import { getWellKnownCatalog } from "../../search/wellKnownCatalog";
+
+export function buildReferencedContentSchema(
+  i18nScope: string,
+  context: IArcGISContext,
+  label?: string
+): IUiSchemaElement {
+  return {
+    scope: "/properties/referencedContentIds",
+    type: "Control",
+    label,
+    options: {
+      control: "hub-field-input-gallery-picker",
+      helperText: {
+        labelKey: `${i18nScope}.fields.referencedContent.helperText.label`,
+      },
+      targetEntity: "item",
+      catalogs: [
+        getWellKnownCatalog(
+          `${i18nScope}.fields.referencedContent`,
+          "organization",
+          "item",
+          {
+            user: context.currentUser,
+            collectionNames: ["site", "initiative", "project"],
+            filters: [],
+            context,
+          }
+        ),
+      ],
+      facets: [
+        {
+          label: `{{${i18nScope}.fields.referencedContent.facets.from.label:translate}}`,
+          key: "from",
+          display: "single-select",
+          operation: "OR",
+          options: [
+            {
+              label: `{{${i18nScope}.fields.referencedContent.facets.from.myContent.label:translate}}`,
+              key: "myContent",
+              selected: true,
+              predicates: [
+                {
+                  owner: context.currentUser.username,
+                },
+              ],
+            },
+            {
+              label: `{{${i18nScope}.fields.referencedContent.facets.from.myOrganization.label:translate}}`,
+              key: "myOrganization",
+              selected: false,
+              predicates: [
+                {
+                  orgId: context.currentUser.orgId,
+                },
+              ],
+            },
+          ],
+        },
+        {
+          label: `{{${i18nScope}.fields.referencedContent.facets.access.label:translate}}`,
+          key: "access",
+          field: "access",
+          display: "multi-select",
+          operation: "OR",
+        },
+      ],
+    },
+  };
+}
diff --git a/packages/common/src/events/defaults.ts b/packages/common/src/events/defaults.ts
@@ -31,7 +31,8 @@ export function buildDefaultEventEntity(): Partial<IHubEvent> {
     onlineCapacityType: HubEventCapacityType.Unlimited,
     onlineDetails: null,
     onlineUrl: null,
-    references: [],
+    referencedContentIds: [],
+    referencedContentIdsByType: [],
     schemaVersion: 1,
     tags: [],
     readGroupIds: [],
@@ -57,6 +58,7 @@ export function buildDefaultEventRecord(): Partial<IEvent> {
     access: EventAccess.PRIVATE,
     allDay: false,
     allowRegistration: true,
+    associations: [],
     attendanceType: [EventAttendanceType.IN_PERSON],
     categories: [],
     inPersonCapacity: null,

diff --git a/packages/common/src/events/edit.ts b/packages/common/src/events/edit.ts
@@ -15,6 +15,7 @@ import {
   IRegistration,
   RegistrationRole,
 } from "./api";
+import { buildEventAssociations } from "./_internal/buildEventAssociations";
 
 export interface IHubCreateEventRegistration {
   eventId: string;
@@ -30,7 +31,7 @@ export interface IHubCreateEventRegistration {
  *
  * @param partialEvent a partial event
  * @param requestOptions user request options
- * @returns promise that resolves a IHubEvent
+ * @returns promise that resolves an IHubEvent
  */
 export async function createHubEvent(
   partialEvent: Partial<IHubEvent>,
@@ -48,10 +49,17 @@ export async function createHubEvent(
 
   let model = mapper.entityToStore(event, buildDefaultEventRecord());
 
+  const associations = await buildEventAssociations(
+    partialEvent.referencedContentIdsByType,
+    partialEvent.referencedContentIds,
+    requestOptions
+  );
+
   const data = {
     access: model.access,
     allDay: model.allDay,
     allowRegistration: model.allowRegistration,
+    associations,
     attendanceType: model.attendanceType,
     categories: model.categories,
     description: model.description,
@@ -98,10 +106,17 @@ export async function updateHubEvent(
 
   let model = mapper.entityToStore(eventUpdates, buildDefaultEventRecord());
 
+  const associations = await buildEventAssociations(
+    partialEvent.referencedContentIdsByType,
+    partialEvent.referencedContentIds,
+    requestOptions
+  );
+
   const data = {
     access: model.access,
     allDay: model.allDay,
     allowRegistration: model.allowRegistration,
+    associations,
     attendanceType: model.attendanceType,
     categories: model.categories,
     description: model.description,

diff --git a/packages/common/src/events/fetch.ts b/packages/common/src/events/fetch.ts
@@ -20,6 +20,9 @@ export function fetchEvent(
   const id = spl[spl.length - 1];
   return getEvent({
     eventId: id,
+    data: {
+      include: "associations",
+    },
     ...requestOptions,
   })
     .then((event) => convertClientEventToHubEvent(event, requestOptions))

diff --git a/packages/common/src/search/_internal/hubEventsHelpers/processFilters.ts b/packages/common/src/search/_internal/hubEventsHelpers/processFilters.ts
@@ -117,5 +117,21 @@ export async function processFilters(
       startDateRange[0].from
     ).toISOString();
   }
+  const endDateRange = getPredicateValuesByKey<IDateRange<string | number>>(
+    filters,
+    "endDateRange"
+  );
+  if (endDateRange.length) {
+    // TODO: remove below ts-ignore once https://devtopia.esri.com/dc/hub/issues/11097 is resolved
+    // @ts-ignore
+    processedFilters.endDateTimeBefore = new Date(
+      endDateRange[0].to
+    ).toISOString();
+    // TODO: remove below ts-ignore once https://devtopia.esri.com/dc/hub/issues/11097 is resolved
+    // @ts-ignore
+    processedFilters.endDateTimeAfter = new Date(
+      endDateRange[0].from
+    ).toISOString();
+  }
   return processedFilters;
 }
diff --git a/packages/common/src/search/_internal/hubEventsHelpers/processOptions.ts b/packages/common/src/search/_internal/hubEventsHelpers/processOptions.ts
@@ -26,6 +26,8 @@ export function processOptions(
     processedOptions.sortBy = EventSort.createdAt;
   } else if (options.sortField === "title") {
     processedOptions.sortBy = EventSort.title;
+  } else if (options.sortField === "startDate") {
+    processedOptions.sortBy = EventSort.startDateTime;
   }
   processedOptions.sortOrder =
     options.sortOrder === "desc" ? EventSortOrder.desc : EventSortOrder.asc;