feat(hub-common): introduces types and function modifications for dis…

…cussion post search (#1425)

packages/common/src/search/_internal/commonHelpers/getApi.ts

@@ -33,7 +33,7 @@ export function getApi(
   } else if (shouldUseDiscussionsApi(targetEntity, options)) {
     result = getDiscussionsApiDefinition();
   } else if (shouldUseOgcApi(targetEntity, options)) {
-    result = getOgcApiDefinition(options);
+    result = getOgcApiDefinition(targetEntity, options);
   } else {
     result = { type: "arcgis", url: portal };
   }

packages/common/src/search/_internal/commonHelpers/getOgcApiDefinition.ts

@@ -1,3 +1,4 @@
+import { EntityType } from "../../types";
 import { IHubSearchOptions } from "../../types/IHubSearchOptions";
 import { IApiDefinition } from "../../types/types";
 
@@ -9,11 +10,17 @@ import { IApiDefinition } from "../../types/types";
  * @returns an IApiDefinition with needed info to target the OGC API
  */
 export function getOgcApiDefinition(
+  targetEntity: EntityType,
   options: IHubSearchOptions
 ): IApiDefinition {
   const umbrellaDomain = new URL(options.requestOptions.hubApiUrl).hostname;
-  return {
-    type: "arcgis-hub",
-    url: `https://${umbrellaDomain}/api/search/v1`,
-  };
+  return targetEntity === "discussionPost"
+    ? {
+        type: "arcgis-hub",
+        url: `https://${umbrellaDomain}/api/search/v2`,
+      }
+    : {
+        type: "arcgis-hub",
+        url: `https://${umbrellaDomain}/api/search/v1`,
+      };
 }

packages/common/src/search/_internal/commonHelpers/shouldUseOgcApi.ts

@@ -15,5 +15,7 @@ export function shouldUseOgcApi(
     site,
     requestOptions: { isPortal },
   } = options;
-  return targetEntity === "item" && !!site && !isPortal;
+  if (isPortal) return false;
+  if (targetEntity === "discussionPost") return true;
+  return targetEntity === "item" && !!site;
 }

packages/common/src/search/_internal/hubSearchItemsHelpers/formatOgcItemsResponse.ts

@@ -1,15 +1,55 @@
 import { IQuery } from "../../types/IHubCatalog";
 import { IHubSearchOptions } from "../../types/IHubSearchOptions";
 import { IHubSearchResponse } from "../../types/IHubSearchResponse";
-import { IHubSearchResult } from "../../types/IHubSearchResult";
 import { getNextOgcCallback } from "./getNextOgcCallback";
 import { IOgcItemsResponse } from "./interfaces";
 import { ogcItemToSearchResult } from "./ogcItemToSearchResult";
+import { ogcItemToDiscussionPostResult } from "./ogcItemToDiscussionPostResult";
+import { IHubSearchResult } from "../../types";
 
 export async function formatOgcItemsResponse(
   response: IOgcItemsResponse,
   originalQuery: IQuery,
   originalOptions: IHubSearchOptions
+): Promise<IHubSearchResponse<IHubSearchResult>> {
+  if (originalQuery.targetEntity === "discussionPost") {
+    return formatDiscussionPostTargetEntityResponse(
+      response,
+      originalQuery,
+      originalOptions
+    );
+  }
+
+  return formatItemTargetEntityResponse(
+    response,
+    originalQuery,
+    originalOptions
+  );
+}
+
+async function formatDiscussionPostTargetEntityResponse(
+  response: IOgcItemsResponse,
+  originalQuery: IQuery,
+  originalOptions: IHubSearchOptions
+): Promise<IHubSearchResponse<IHubSearchResult>> {
+  const formattedResults = await Promise.all(
+    response.features.map((f) => ogcItemToDiscussionPostResult(f))
+  );
+  const next = getNextOgcCallback(response, originalQuery, originalOptions);
+  const nextLink = response.links.find((l) => l.rel === "next");
+
+  return {
+    total: response.numberMatched,
+    results: formattedResults,
+    hasNext: !!nextLink,
+    next,
+  };
+}
+
+async function formatItemTargetEntityResponse(
+  response: IOgcItemsResponse,
+  originalQuery: IQuery,
+  originalOptions: IHubSearchOptions
 ): Promise<IHubSearchResponse<IHubSearchResult>> {
   const formattedResults = await Promise.all(
     response.features.map((f) =>

packages/common/src/search/_internal/hubSearchItemsHelpers/getOgcCollectionUrl.ts

@@ -15,6 +15,11 @@ import { IApiDefinition } from "../../types/types";
  */
 export function getOgcCollectionUrl(query: IQuery, options: IHubSearchOptions) {
   const apiDefinition = options.api as IApiDefinition;
+  // Discussion posts as a target entity will be searchable with one collection,
+  // so simply use that for the URL
+  if (query.targetEntity === "discussionPost") {
+    return `${apiDefinition.url}/collections/discussion-post`;
+  }
   const collectionId = query.collection || "all";
   return `${apiDefinition.url}/collections/${collectionId}`;
 }

packages/common/src/search/_internal/hubSearchItemsHelpers/ogcItemToDiscussionPostResult.ts

@@ -0,0 +1,34 @@
+import { IOgcItem } from "./interfaces";
+import { IPost } from "../../../discussions";
+import { IHubSearchResult } from "../../types";
+
+/**
+ * This method is responsible for converting an OGC item whose properties
+ * represent an IPost into an IHubSearchResult. Although some fields do not
+ * apply, this is being done such that result of a discussion post search
+ * can automatically be used in a gallery.
+ * @param ogcItem
+ * @returns IHubSearchResult
+ */
+export async function ogcItemToDiscussionPostResult(
+  ogcItem: IOgcItem
+): Promise<IHubSearchResult> {
+  return {
+    id: ogcItem.id,
+    name: ogcItem.properties.title,
+    summary: ogcItem.properties.body,
+    createdDate: new Date(ogcItem.properties.createdAt),
+    createdDateSource: "properties.createdAt",
+    updatedDate: new Date(ogcItem.properties.updatedAt),
+    updatedDateSource: "properties.updatedAt",
+    type: ogcItem.properties.postType,
+    owner: ogcItem.properties.creator,
+    location: ogcItem.properties.geometry,
+    created: new Date(ogcItem.properties.createdAt),
+    modified: new Date(ogcItem.properties.updatedAt),
+    title: ogcItem.properties.title,
+    rawResult: ogcItem.properties,
+    access: null,
+    family: null,
+  } as IHubSearchResult;
+}

packages/common/src/search/_internal/hubSearchItemsHelpers/ogcItemToSearchResult.ts

@@ -1,9 +1,5 @@
 import { IItem } from "@esri/arcgis-rest-types";
-import {
-  IHubGeography,
-  IHubRequestOptions,
-  IPolygonProperties,
-} from "../../../types";
+import { IHubRequestOptions } from "../../../types";
 import { IHubSearchResult } from "../../types/IHubSearchResult";
 import { itemToSearchResult } from "../portalSearchItems";
 import { IOgcItem } from "./interfaces";

packages/common/src/search/hubSearch.ts

@@ -85,6 +85,7 @@ export async function hubSearch(
     "arcgis-hub": {
       item: hubSearchItems,
       channel: hubSearchChannels,
+      discussionPost: hubSearchItems,
     },
   };
 

packages/common/src/search/types/IHubCatalog.ts

@@ -61,7 +61,8 @@ export type EntityType =
   | "communityUser"
   | "groupMember"
   | "event"
-  | "channel";
+  | "channel"
+  | "discussionPost";
 /**
  * @private
  *

packages/common/test/search/_internal/getApi.test.ts

@@ -57,4 +57,17 @@ describe("getApi", () => {
       url: portal,
     });
   });
+  it("otherwise returns reference to OGC API V2 API if targetEntity is discussionPost", () => {
+    const options = {
+      site,
+      requestOptions: {
+        hubApiUrl,
+        isPortal: false,
+      },
+    } as unknown as IHubSearchOptions;
+    expect(getApi("discussionPost", options)).toEqual({
+      type: "arcgis-hub",
+      url: `${hubApiUrl}/api/search/v2`,
+    });
+  });
 });