feat(hub-common): add location props (#1684)

Co-authored-by: juliannemarik <[email protected]>
Esri · Oct 17, 2024 · 5b5e27c · 5b5e27c
1 parent 62fb8ce
commit 5b5e27c
Show file tree

Hide file tree

Showing 10 changed files with 62 additions and 3 deletions.
diff --git a/packages/common/src/core/schemas/shared/subschemas.ts b/packages/common/src/core/schemas/shared/subschemas.ts
@@ -53,6 +53,16 @@ export const ENTITY_FEATURED_CONTENT_SCHEMA = {
 export const ENTITY_LOCATION_SCHEMA = {
   type: "object",
   default: { type: "none" },
+  properties: {
+    type: {
+      type: "string",
+      enum: ["none", "org", "custom"],
+      default: "none",
+    },
+    name: {
+      type: "string",
+    },
+  },
 };
 
 /**

diff --git a/packages/common/src/core/types/IHubLocation.ts b/packages/common/src/core/types/IHubLocation.ts
@@ -32,6 +32,7 @@ export interface IHubLocation {
   orgSpatialReference?: ISpatialReference;
   graphic?: any;
   geoJson?: any;
+  name?: string;
 }
 
 /**

diff --git a/packages/common/src/events/_internal/EventSchemaEdit.ts b/packages/common/src/events/_internal/EventSchemaEdit.ts
@@ -1,5 +1,6 @@
 import {
   ENTITY_CATEGORIES_SCHEMA,
+  ENTITY_LOCATION_SCHEMA,
   ENTITY_NAME_SCHEMA,
   ENTITY_SUMMARY_SCHEMA,
   ENTITY_TAGS_SCHEMA,
@@ -67,7 +68,17 @@ export const buildSchema = (): IConfigurationSchema => {
         default: HubEventCapacityType.Unlimited,
       },
       location: {
-        type: "object",
+        ...ENTITY_LOCATION_SCHEMA,
+        allOf: [
+          {
+            if: {
+              properties: { type: { enum: ["custom", "org"] } },
+            },
+            then: {
+              required: ["name"],
+            },
+          },
+        ],
       },
       onlineUrl: {
         type: "string",

diff --git a/packages/common/src/events/_internal/EventUiSchemaEdit.ts b/packages/common/src/events/_internal/EventUiSchemaEdit.ts
@@ -212,6 +212,14 @@ export const buildUiSchema = async (
                 context.portal.name,
                 context.hubRequestOptions
               ),
+              locationNameRequired: true,
+              messages: [
+                {
+                  type: "ERROR",
+                  keyword: "if",
+                  hidden: true,
+                },
+              ],
             },
           },
           {

diff --git a/packages/common/src/events/_internal/PropertyMapper.ts b/packages/common/src/events/_internal/PropertyMapper.ts
@@ -194,6 +194,7 @@ export class EventPropertyMapper extends PropertyMapper<
             spatialReference: clonedEntity.location.spatialReference,
             extent: clonedEntity.location.extent,
             geometries: clonedEntity.location.geometries,
+            placeName: clonedEntity.location.name,
           } as IEventLocation)
         : null;
 

diff --git a/packages/common/src/events/_internal/getLocationFromEvent.ts b/packages/common/src/events/_internal/getLocationFromEvent.ts
@@ -8,6 +8,7 @@ export function getLocationFromEvent(event: Partial<IEvent>): IHubLocation {
         spatialReference: event.location.spatialReference,
         extent: event.location.extent,
         geometries: event.location.geometries,
+        name: event.location.placeName,
       }
     : { type: "none" };
 }
diff --git a/packages/common/test/events/_internal/EventSchemaEdit.test.ts b/packages/common/test/events/_internal/EventSchemaEdit.test.ts
@@ -2,7 +2,7 @@ import { buildSchema } from "../../../src/events/_internal/EventSchemaEdit";
 import { IConfigurationSchema } from "../../../src/core/schemas/types";
 import {
   ENTITY_CATEGORIES_SCHEMA,
-  ENTITY_FEATURED_CONTENT_SCHEMA,
+  ENTITY_LOCATION_SCHEMA,
   ENTITY_NAME_SCHEMA,
   ENTITY_SUMMARY_SCHEMA,
   ENTITY_TAGS_SCHEMA,
@@ -80,7 +80,17 @@ describe("EventSchemaEdit", () => {
             default: HubEventCapacityType.Unlimited,
           },
           location: {
-            type: "object",
+            ...ENTITY_LOCATION_SCHEMA,
+            allOf: [
+              {
+                if: {
+                  properties: { type: { enum: ["custom", "org"] } },
+                },
+                then: {
+                  required: ["name"],
+                },
+              },
+            ],
           },
           onlineUrl: {
             type: "string",

diff --git a/packages/common/test/events/_internal/EventUiSchemaEdit.test.ts b/packages/common/test/events/_internal/EventUiSchemaEdit.test.ts
@@ -322,6 +322,14 @@ describe("EventUiSchemaEdit", () => {
                   control: "hub-field-input-location-picker",
                   extent: [],
                   options: [],
+                  locationNameRequired: true,
+                  messages: [
+                    {
+                      type: "ERROR",
+                      keyword: "if",
+                      hidden: true,
+                    },
+                  ],
                 },
               },
               {

diff --git a/packages/common/test/events/_internal/getLocationFromEvent.test.ts b/packages/common/test/events/_internal/getLocationFromEvent.test.ts
@@ -77,6 +77,7 @@ describe("getLocationFromEvent", () => {
           spatialReference: Object({ wkid: 4326 }),
         },
       ],
+      name: null,
     } as unknown as IHubLocation);
   });
   it('should return a location object of type "custom" with a point', () => {
@@ -132,6 +133,7 @@ describe("getLocationFromEvent", () => {
           spatialReference: Object({ wkid: 4326 }),
         },
       ],
+      name: null,
     } as unknown as IHubLocation);
   });
   it('should return a location object of type "custom" with a polyline', () => {
@@ -203,6 +205,7 @@ describe("getLocationFromEvent", () => {
           spatialReference: { wkid: 4326 },
         },
       ],
+      name: null,
     } as unknown as IHubLocation);
   });
   it('should return a location object of type "custom" with a polygon', () => {
@@ -270,6 +273,7 @@ describe("getLocationFromEvent", () => {
           spatialReference: { wkid: 4326 },
         },
       ],
+      name: null,
     } as unknown as IHubLocation);
   });
   it('should return a location object of type "custom" with a extent', () => {
@@ -329,6 +333,7 @@ describe("getLocationFromEvent", () => {
           spatialReference: { wkid: 4326 },
         },
       ],
+      name: null,
     } as unknown as IHubLocation);
   });
 });
diff --git a/packages/common/test/events/edit.test.ts b/packages/common/test/events/edit.test.ts
@@ -189,6 +189,7 @@ describe("HubEvents edit module", () => {
             spatialReference: {},
             extent: [[]],
             geometries: [],
+            name: "",
           },
           referencedContentIds: ["8nd"],
           referencedContentIdsByType: [
@@ -252,6 +253,7 @@ describe("HubEvents edit module", () => {
             spatialReference: {},
             extent: [[]],
             geometries: [],
+            placeName: "",
           },
         },
         ...context.hubRequestOptions,
@@ -299,6 +301,7 @@ describe("HubEvents edit module", () => {
             spatialReference: {},
             extent: [[]],
             geometries: [],
+            name: "",
           },
           referencedContentIds: ["8nd"],
           referencedContentIdsByType: [
@@ -364,6 +367,7 @@ describe("HubEvents edit module", () => {
             spatialReference: {},
             extent: [[]],
             geometries: [],
+            placeName: "",
           },
         },
         ...context.hubRequestOptions,