fix: encode item extent prior to calling request

Esri · Sep 22, 2022 · 135600c · 135600c
1 parent d0dcbcb
commit 135600c
Show file tree

Hide file tree

Showing 5 changed files with 56 additions and 3 deletions.
diff --git a/packages/arcgis-rest-portal/src/items/create.ts b/packages/arcgis-rest-portal/src/items/create.ts
@@ -9,7 +9,9 @@ import {
   IAddFolderResponse,
   IUpdateItemResponse,
   ICreateUpdateItemOptions,
-  determineOwner
+  determineOwner,
+  isBBox,
+  bboxToString
 } from "./helpers.js";
 
 export interface ICreateFolderOptions extends ICreateUpdateItemOptions {
@@ -99,6 +101,14 @@ export function createItemInFolder(
       ...requestOptions.item
     };
 
+    // convert extent, if present, into a string from bbox
+    // processParams was previously doing this sort of work,
+    // however now we need to let array of arrays through
+    // Thus for extents we need to move this logic here
+    if (requestOptions.params.extent && isBBox(requestOptions.params.extent)) {
+      requestOptions.params.extent = bboxToString(requestOptions.params.extent);
+    }
+
     // serialize the item into something Portal will accept
     const options = appendCustomParams<ICreateItemOptions>(
       requestOptions,

diff --git a/packages/arcgis-rest-portal/src/items/helpers.ts b/packages/arcgis-rest-portal/src/items/helpers.ts
@@ -270,3 +270,26 @@ export function determineOwner(requestOptions: any): Promise<string> {
     );
   }
 }
+
+/**
+ * checks if the extent is a valid BBox (2 element array of coordinate pair arrays)
+ * @param extent
+ * @returns
+ */
+export function isBBox(extent: unknown): boolean {
+  return (
+    Array.isArray(extent) &&
+    Array.isArray(extent[0]) &&
+    Array.isArray(extent[1])
+  );
+}
+
+/**
+ * Given a Bbox, convert it to a string. Some api endpoints expect a string
+ *
+ * @param {BBox} extent
+ * @return {*}  {string}
+ */
+export function bboxToString(extent: number[][]): string {
+  return extent.join(",");
+}
diff --git a/packages/arcgis-rest-portal/src/items/update.ts b/packages/arcgis-rest-portal/src/items/update.ts
@@ -13,7 +13,9 @@ import {
   IItemInfoResponse,
   IItemResourceResponse,
   IUpdateItemResponse,
-  determineOwner
+  determineOwner,
+  isBBox,
+  bboxToString
 } from "./helpers.js";
 
 export interface IUpdateItemOptions extends ICreateUpdateItemOptions {
@@ -69,6 +71,14 @@ export function updateItem(
       ...requestOptions.item
     };
 
+    // convert extent, if present, into a string from bbox
+    // processParams was previously doing this sort of work,
+    // however now we need to let array of arrays through
+    // Thus for extents we need to move this logic here
+    if (requestOptions.params.extent && isBBox(requestOptions.params.extent)) {
+      requestOptions.params.extent = bboxToString(requestOptions.params.extent);
+    }
+
     return request(url, requestOptions);
   });
 }

diff --git a/packages/arcgis-rest-portal/test/items/create.test.ts b/packages/arcgis-rest-portal/test/items/create.test.ts
@@ -48,6 +48,10 @@ describe("search", () => {
         type: "Web Mapping Application",
         typeKeywords: ["fake", "kwds"],
         tags: ["fakey", "mcfakepants"],
+        extent: [
+          [1, 2],
+          [3, 4]
+        ],
         properties: {
           key: "somevalue"
         },
@@ -73,6 +77,7 @@ describe("search", () => {
           expect(options.body).toContain(encodeParam("token", "fake-token"));
           expect(options.body).toContain("owner=dbouwman");
           // ensure the array props are serialized into strings
+          expect(options.body).toContain(encodeParam("extent", "1,2,3,4"));
           expect(options.body).toContain(
             encodeParam("typeKeywords", "fake,kwds")
           );
@@ -383,7 +388,7 @@ describe("search", () => {
       fetchMock.post("*", () => 200);
       createItemInFolder({
         item: fakeItem,
-        file: new File(["some text"], undefined, {
+        file: new File(["some text"], undefined as unknown as string, {
           type: "text/html"
         }),
         multipart: true,

diff --git a/packages/arcgis-rest-portal/test/items/update.test.ts b/packages/arcgis-rest-portal/test/items/update.test.ts
@@ -53,6 +53,10 @@ describe("search", () => {
         type: "Web Mapping Application",
         typeKeywords: ["fake", "kwds"],
         tags: ["fakey", "mcfakepants"],
+        extent: [
+          [1, 2],
+          [3, 4]
+        ],
         properties: {
           key: "somevalue"
         },
@@ -74,6 +78,7 @@ describe("search", () => {
           expect(options.body).toContain(encodeParam("token", "fake-token"));
           expect(options.body).toContain(encodeParam("owner", "dbouwman"));
           // ensure the array props are serialized into strings
+          expect(options.body).toContain(encodeParam("extent", "1,2,3,4"));
           expect(options.body).toContain(
             encodeParam("typeKeywords", "fake,kwds")
           );