feat(hub-discussions): add exportPosts fn to export discussion posts …

…as CSV string (#1745)
Esri · Nov 22, 2024 · 5dba4b4 · 5dba4b4
1 parent 603ac70
commit 5dba4b4
Show file tree

Hide file tree

Showing 5 changed files with 149 additions and 35 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/discussions/package.json b/packages/discussions/package.json
@@ -13,10 +13,10 @@
   "peerDependencies": {
     "@esri/arcgis-rest-auth": "^2.14.0 || 3",
     "@esri/arcgis-rest-request": "^2.14.0 || 3",
-    "@esri/hub-common": "^15.7.1"
+    "@esri/hub-common": "^15.8.0"
   },
   "devDependencies": {
-    "@esri/hub-common": "^15.7.1",
+    "@esri/hub-common": "^15.8.0",
     "@types/geojson": "^7946.0.7",
     "typescript": "^3.8.1"
   },

diff --git a/packages/discussions/src/posts/posts.ts b/packages/discussions/src/posts/posts.ts
@@ -1,10 +1,15 @@
 /* tslint:disable unified-signatures */
-import { discussionsApiRequest } from "@esri/hub-common";
+import {
+  discussionsApiRequest,
+  ISearchPosts,
+  SearchPostsFormat,
+} from "@esri/hub-common";
 import {
   ICreatePostParams,
   ICreateReplyParams,
   IPost,
   ISearchPostsParams,
+  IExportPostsParams,
   IFetchPostParams,
   IRemovePostParams,
   IRemovePostResponse,
@@ -13,6 +18,21 @@ import {
   IPagedResponse,
 } from "../types";
 
+const stringifySearchParams = (data: ISearchPosts): any => {
+  // need to serialize geometry and featureGeometry since this
+  // is a GET request. we should consider requiring this to be
+  // a base64 string to safeguard against large geometries that
+  // will exceed URL character limits
+  const paramsToStringify = ["geometry", "featureGeometry"];
+  return Object.entries(data ?? {}).reduce(
+    (acc, [key, val]) => ({
+      ...acc,
+      [key]: paramsToStringify.includes(key) ? JSON.stringify(val) : val,
+    }),
+    {}
+  );
+};
+
 /**
  * search posts
  *
@@ -24,24 +44,34 @@ export function searchPosts(
   options: ISearchPostsParams
 ): Promise<IPagedResponse<IPost>> {
   const url = `/posts`;
-  // need to serialize geometry and featureGeometry since this
-  // is a GET request. we should consider requiring this to be
-  // a base64 string to safeguard against large geometries that
-  // will exceed URL character limits
-  const data = ["geometry", "featureGeometry"].reduce(
-    (acc, property) =>
-      acc[property]
-        ? { ...acc, [property]: JSON.stringify(acc[property]) }
-        : acc,
-    { ...(options.data ?? {}) } as any
-  );
-  return discussionsApiRequest(url, {
+  const data = stringifySearchParams(options.data);
+  return discussionsApiRequest<IPagedResponse<IPost>>(url, {
     ...options,
     data,
     httpMethod: "GET",
   });
 }
 
+/**
+ * searches for posts and resolves a promise with CSV string representing the results
+ *
+ * @export
+ * @param {IExportPostsParams} options
+ * @return {*}  {Promise<string>}
+ */
+export function exportPosts(options: IExportPostsParams): Promise<string> {
+  const url = `/posts`;
+  const data = stringifySearchParams(options.data);
+  return discussionsApiRequest<string>(url, {
+    ...options,
+    data: {
+      ...data,
+      f: SearchPostsFormat.CSV,
+    },
+    httpMethod: "GET",
+  });
+}
+
 /**
  * create post
  *

diff --git a/packages/discussions/src/types.ts b/packages/discussions/src/types.ts
@@ -44,6 +44,7 @@ export {
   IUpdatePostStatus,
   IUpdatePost,
   ISearchPostsParams,
+  IExportPostsParams,
   IFetchPostParams,
   IUpdatePostParams,
   IUpdatePostStatusParams,

diff --git a/packages/discussions/test/posts.test.ts b/packages/discussions/test/posts.test.ts
@@ -7,6 +7,7 @@ import {
   removePost,
   createReply,
   updatePostStatus,
+  exportPosts,
 } from "../src/posts";
 import * as hubCommon from "@esri/hub-common";
 import {
@@ -16,6 +17,7 @@ import {
   IFetchPostParams,
   PostStatus,
   Role,
+  SearchPostsFormat,
   SharingAccess,
 } from "../src/types";
 
@@ -145,6 +147,31 @@ describe("posts", () => {
       .catch(() => fail());
   });
 
+  it("exports posts as a CSV string", (done) => {
+    const query = {
+      access: [SharingAccess.PUBLIC],
+      groups: ["foo"],
+    };
+
+    const options = { ...baseOpts, data: query };
+    exportPosts(options)
+      .then(() => {
+        expect(requestSpy.calls.count()).toEqual(1);
+        const [url, opts] = requestSpy.calls.argsFor(0);
+        expect(url).toEqual(`/posts`);
+        expect(opts).toEqual({
+          ...options,
+          data: {
+            ...options.data,
+            f: SearchPostsFormat.CSV,
+          },
+          httpMethod: "GET",
+        });
+        done();
+      })
+      .catch(() => fail());
+  });
+
   it("creates post on unknown or non-existent channel", (done) => {
     const body = {
       access: SharingAccess.PRIVATE,