fix: let request do the serializing

AFFECTS PACKAGES: @esri/arcgis-rest-groups @esri/arcgis-rest-items
Esri · Feb 28, 2019 · c2d2671 · c2d2671
1 parent 8f94d82
commit c2d2671
Show file tree

Hide file tree

Showing 7 changed files with 56 additions and 60 deletions.
diff --git a/packages/arcgis-rest-groups/src/create.ts b/packages/arcgis-rest-groups/src/create.ts
@@ -7,9 +7,9 @@ import {
   getPortalUrl
 } from "@esri/arcgis-rest-request";
 
-import { IGroupAdd } from "@esri/arcgis-rest-common-types";
+import { IGroupAdd, IGroup } from "@esri/arcgis-rest-common-types";
 
-import { serializeGroup } from "./helpers";
+// import { serializeGroup } from "./helpers";
 
 export interface IGroupAddRequestOptions extends IRequestOptions {
   group: IGroupAdd;
@@ -36,12 +36,12 @@ export interface IGroupAddRequestOptions extends IRequestOptions {
  */
 export function createGroup(
   requestOptions: IGroupAddRequestOptions
-): Promise<any> {
+): Promise<{ success: boolean; group: IGroup }> {
   const url = `${getPortalUrl(requestOptions)}/community/createGroup`;
   const options: IGroupAddRequestOptions = {
     ...requestOptions
   };
-  // serialize the group into something Portal will accept
-  options.params = serializeGroup(requestOptions.group);
+
+  options.params = requestOptions.group;
   return request(url, options);
 }
diff --git a/packages/arcgis-rest-groups/src/helpers.ts b/packages/arcgis-rest-groups/src/helpers.ts
@@ -11,12 +11,15 @@ export interface IGroupIdRequestOptions extends IRequestOptions {
 
 /**
  * Serialize a group into a json format accepted by the Portal API
- * for create and update operations
+ * for create and update operations.
+ *
+ * Deprecated. Will be removed in v2.0.0.
  *
  * @param group IGroup to be serialized
  * @returns a formatted JSON object to be sent to Portal
  * @private
  */
+/* istanbul ignore next - deprecated method */
 export function serializeGroup(group: IGroupAdd | IItemUpdate | IGroup): any {
   // create a clone so we're not messing with the original
   const clone = JSON.parse(JSON.stringify(group));

diff --git a/packages/arcgis-rest-groups/src/update.ts b/packages/arcgis-rest-groups/src/update.ts
@@ -9,8 +9,6 @@ import {
 
 import { IItemUpdate } from "@esri/arcgis-rest-common-types";
 
-import { serializeGroup } from "./helpers";
-
 export interface IGroupUpdateRequestOptions extends IRequestOptions {
   group: IItemUpdate;
 }
@@ -31,15 +29,15 @@ export interface IGroupUpdateRequestOptions extends IRequestOptions {
  */
 export function updateGroup(
   requestOptions: IGroupUpdateRequestOptions
-): Promise<any> {
+): Promise<{ success: boolean; groupId: string }> {
   const url = `${getPortalUrl(requestOptions)}/community/groups/${
     requestOptions.group.id
   }/update`;
 
   const options: IGroupUpdateRequestOptions = {
     ...requestOptions
   };
-  // serialize the group into something Portal will accept
-  options.params = serializeGroup(requestOptions.group);
+
+  options.params = requestOptions.group;
   return request(url, options);
 }
diff --git a/packages/arcgis-rest-groups/test/crud.test.ts b/packages/arcgis-rest-groups/test/crud.test.ts
@@ -46,7 +46,7 @@ describe("groups", () => {
           expect(options.body).toContain(encodeParam("token", "fake-token"));
           expect(options.body).toContain(encodeParam("owner", "fakeUser"));
           // ensure the array props are serialized into strings
-          expect(options.body).toContain(encodeParam("tags", "foo, bar"));
+          expect(options.body).toContain(encodeParam("tags", "foo,bar"));
           expect(options.body).toContain(encodeParam("access", "public"));
           done();
         })
@@ -103,7 +103,7 @@ describe("groups", () => {
           expect(options.body).toContain(encodeParam("token", "fake-token"));
           expect(options.body).toContain(encodeParam("owner", "fakeUser"));
           // ensure the array props are serialized into strings
-          expect(options.body).toContain(encodeParam("tags", "foo, bar"));
+          expect(options.body).toContain(encodeParam("tags", "foo,bar"));
           done();
         })
         .catch(e => {

diff --git a/packages/arcgis-rest-items/src/helpers.ts b/packages/arcgis-rest-items/src/helpers.ts
@@ -33,25 +33,26 @@ export interface IFolderIdRequestOptions extends IUserRequestOptions {
   owner?: string;
 }
 
-export type ItemRelationshipType = "Map2Service" |
-"WMA2Code" |
-"Map2FeatureCollection" |
-"MobileApp2Code" |
-"Service2Data" |
-"Service2Service" |
-"Map2AppConfig" |
-"Item2Attachment" |
-"Item2Report" |
-"Listed2Provisioned" |
-"Style2Style" |
-"Service2Style" |
-"Survey2Service" |
-"Survey2Data" |
-"Service2Route" |
-"Area2Package" |
-"Map2Area" |
-"Service2Layer" |
-"Area2CustomPackage";
+export type ItemRelationshipType =
+  | "Map2Service"
+  | "WMA2Code"
+  | "Map2FeatureCollection"
+  | "MobileApp2Code"
+  | "Service2Data"
+  | "Service2Service"
+  | "Map2AppConfig"
+  | "Item2Attachment"
+  | "Item2Report"
+  | "Listed2Provisioned"
+  | "Style2Style"
+  | "Service2Style"
+  | "Survey2Service"
+  | "Survey2Data"
+  | "Service2Route"
+  | "Area2Package"
+  | "Map2Area"
+  | "Service2Layer"
+  | "Area2CustomPackage";
 
 export interface IItemRelationshipRequestOptions extends IRequestOptions {
   /**
@@ -61,14 +62,15 @@ export interface IItemRelationshipRequestOptions extends IRequestOptions {
   /**
    * The type of relationship between the two items.
    */
-  relationshipType: ItemRelationshipType | ItemRelationshipType[]
+  relationshipType: ItemRelationshipType | ItemRelationshipType[];
   /**
    * The direction of the relationship. Either forward (from origin -> destination) or reverse (from destination -> origin).
    */
   direction?: "forward" | "reverse";
 }
 
-export interface IManageItemRelationshipRequestOptions extends IUserRequestOptions {
+export interface IManageItemRelationshipRequestOptions
+  extends IUserRequestOptions {
   originItemId: string;
   destinationItemId: string;
   relationshipType: ItemRelationshipType;
@@ -159,28 +161,21 @@ export interface IItemMoveResponse {
 }
 
 /**
- * Serialize an item into a json format accepted by the Portal API
- * for create and update operations
+ * Serialize an item and its data into a json format accepted by the Portal API for create and update operations
  *
  * @param item Item to be serialized
  * @returns a formatted json object to be sent to Portal
  */
 export function serializeItem(item: IItemAdd | IItemUpdate | IItem): any {
   // create a clone so we're not messing with the original
   const clone = JSON.parse(JSON.stringify(item));
-  // join keywords and tags...
-  const { typeKeywords = [], tags = [] } = item;
-  clone.typeKeywords = typeKeywords.join(", ");
-  clone.tags = tags.join(", ");
+
   // convert .data to .text
   if (clone.data) {
     clone.text = JSON.stringify(clone.data);
     delete clone.data;
   }
-  // Convert properties to a string
-  if (clone.properties) {
-    clone.properties = JSON.stringify(clone.properties);
-  }
+
   return clone;
 }
 

diff --git a/packages/arcgis-rest-items/test/create.test.ts b/packages/arcgis-rest-items/test/create.test.ts
@@ -69,10 +69,10 @@ describe("search", () => {
           expect(options.body).toContain("owner=dbouwman");
           // ensure the array props are serialized into strings
           expect(options.body).toContain(
-            encodeParam("typeKeywords", "fake, kwds")
+            encodeParam("typeKeywords", "fake,kwds")
           );
           expect(options.body).toContain(
-            encodeParam("tags", "fakey, mcfakepants")
+            encodeParam("tags", "fakey,mcfakepants")
           );
           expect(options.body).toContain(
             encodeParam("properties", JSON.stringify(fakeItem.properties))
@@ -115,10 +115,10 @@ describe("search", () => {
           expect(options.body).toContain("owner=dbouwman");
           // ensure the array props are serialized into strings
           expect(options.body).toContain(
-            encodeParam("typeKeywords", "fake, kwds")
+            encodeParam("typeKeywords", "fake,kwds")
           );
           expect(options.body).toContain(
-            encodeParam("tags", "fakey, mcfakepants")
+            encodeParam("tags", "fakey,mcfakepants")
           );
           expect(options.body).toContain(
             encodeParam("properties", JSON.stringify(fakeItem.properties))
@@ -161,10 +161,10 @@ describe("search", () => {
           // expect(options.body).toContain("owner=casey");
           // ensure the array props are serialized into strings
           expect(options.body).toContain(
-            encodeParam("typeKeywords", "fake, kwds")
+            encodeParam("typeKeywords", "fake,kwds")
           );
           expect(options.body).toContain(
-            encodeParam("tags", "fakey, mcfakepants")
+            encodeParam("tags", "fakey,mcfakepants")
           );
           expect(options.body).toContain(
             encodeParam("properties", JSON.stringify(fakeItem.properties))
@@ -245,10 +245,10 @@ describe("search", () => {
           expect(options.body).toContain("owner=dbouwman");
           // ensure the array props are serialized into strings
           expect(options.body).toContain(
-            encodeParam("typeKeywords", "fake, kwds")
+            encodeParam("typeKeywords", "fake,kwds")
           );
           expect(options.body).toContain(
-            encodeParam("tags", "fakey, mcfakepants")
+            encodeParam("tags", "fakey,mcfakepants")
           );
           done();
         })
@@ -290,10 +290,10 @@ describe("search", () => {
           expect(options.body).toContain("foo=bar");
           // ensure the array props are serialized into strings
           expect(options.body).toContain(
-            encodeParam("typeKeywords", "fake, kwds")
+            encodeParam("typeKeywords", "fake,kwds")
           );
           expect(options.body).toContain(
-            encodeParam("tags", "fakey, mcfakepants")
+            encodeParam("tags", "fakey,mcfakepants")
           );
           done();
         })
@@ -329,10 +329,10 @@ describe("search", () => {
           expect(options.body).toContain("owner=casey");
           // ensure the array props are serialized into strings
           expect(options.body).toContain(
-            encodeParam("typeKeywords", "fake, kwds")
+            encodeParam("typeKeywords", "fake,kwds")
           );
           expect(options.body).toContain(
-            encodeParam("tags", "fakey, mcfakepants")
+            encodeParam("tags", "fakey,mcfakepants")
           );
           done();
         })

diff --git a/packages/arcgis-rest-items/test/update.test.ts b/packages/arcgis-rest-items/test/update.test.ts
@@ -70,10 +70,10 @@ describe("search", () => {
           expect(options.body).toContain(encodeParam("owner", "dbouwman"));
           // ensure the array props are serialized into strings
           expect(options.body).toContain(
-            encodeParam("typeKeywords", "fake, kwds")
+            encodeParam("typeKeywords", "fake,kwds")
           );
           expect(options.body).toContain(
-            encodeParam("tags", "fakey, mcfakepants")
+            encodeParam("tags", "fakey,mcfakepants")
           );
           expect(options.body).toContain(
             encodeParam("text", JSON.stringify(fakeItem.data))
@@ -135,10 +135,10 @@ describe("search", () => {
           );
           // ensure the array props are serialized into strings
           expect(options.body).toContain(
-            encodeParam("typeKeywords", "fake, kwds")
+            encodeParam("typeKeywords", "fake,kwds")
           );
           expect(options.body).toContain(
-            encodeParam("tags", "fakey, mcfakepants")
+            encodeParam("tags", "fakey,mcfakepants")
           );
           expect(options.body).toContain(
             encodeParam("text", JSON.stringify(fakeItem.data))