feat(group): refactor searchGroups to make use of SearchQueryBuilder

AFFECTS PACKAGES:
@esri/arcgis-rest-portal

BREAKING CHANGE:
searchGroups signature change

ISSUES CLOSED: #104

packages/arcgis-rest-portal/src/groups/search.ts

@@ -1,65 +1,24 @@
-/* Copyright (c) 2017-2018 Environmental Systems Research Institute, Inc.
+/* Copyright (c) 2018-2019 Environmental Systems Research Institute, Inc.
  * Apache-2.0 */
 
-import {
-  request,
-  IRequestOptions,
-  IPagingParams,
-  IGroup
-} from "@esri/arcgis-rest-request";
-
-import { getPortalUrl } from "../util/get-portal-url";
-
-export interface IGroupSearchRequest extends IPagingParams {
-  q: string;
-  sortField?: string;
-  sortOrder?: string;
-  [key: string]: any;
-}
-
-export interface IGroupSearchResult {
-  /**
-   * Matches the REST APIs form param
-   */
-  query: string;
-  total: number;
-  start: number;
-  num: number;
-  nextStart: number;
-  results: IGroup[];
-}
+import { SearchQueryBuilder } from "../util/SearchQueryBuilder";
+import { ISearchRequestOptions, ISearchResult } from "../util/search";
+import { genericSearch } from "../util/generic-search";
 
 /**
- *
  * ```js
- * import { searchGroups } from '@esri/arcgis-rest-groups';
+ * import { searchGroups } from "@esri/arcgis-rest-portal";
  * //
- * searchGroups({
- *   q:'water'
- * })
- *   .then(response) // response.results.total => 355
+ * searchGroups('water')
+ *   .then(response) // response.total => 355
  * ```
- * Search a portal for groups. See the [REST Documentation](https://developers.arcgis.com/rest/users-groups-and-items/group-search.htm) for more information.
+ * Search a portal for items. See the [REST Documentation](https://developers.arcgis.com/rest/users-groups-and-items/search.htm) for more information.
  *
- * @param searchForm - Search request
- * @param requestOptions - Options for the request
+ * @param search - A string or RequestOptions object to pass through to the endpoint.
  * @returns A Promise that will resolve with the data from the response.
  */
 export function searchGroups(
-  searchForm: IGroupSearchRequest,
-  requestOptions?: IRequestOptions
-): Promise<IGroupSearchResult> {
-  // construct the search url
-  const url = `${getPortalUrl(requestOptions)}/community/groups`;
-
-  // default to a GET
-  const options: IRequestOptions = {
-    ...{ httpMethod: "GET" },
-    ...requestOptions
-  };
-
-  options.params = { ...searchForm };
-
-  // send the request
-  return request(url, options);
+  search: string | ISearchRequestOptions | SearchQueryBuilder
+): Promise<ISearchResult> {
+  return genericSearch(search, "group");
 }

packages/arcgis-rest-portal/src/index.ts

@@ -7,7 +7,6 @@ export * from "./items/get";
 export * from "./items/protect";
 export * from "./items/remove";
 export * from "./items/search";
-export * from "./items/SearchQueryBuilder";
 export * from "./items/update";
 export * from "./items/helpers";
 
@@ -33,3 +32,7 @@ export * from "./sharing/helpers";
 
 export * from "./util/get-portal";
 export * from "./util/get-portal-url";
+export * from "./util/search";
+export * from "./util/SearchQueryBuilder";
+// we dont export 'generic-search' because its an internal utility method
+// export * from "./util/generic-search"; because its an internal utility method

packages/arcgis-rest-portal/src/items/search.ts

@@ -1,36 +1,9 @@
-/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+/* Copyright (c) 2018-2019 Environmental Systems Research Institute, Inc.
  * Apache-2.0 */
 
-import {
-  request,
-  IRequestOptions,
-  appendCustomParams,
-  IPagingParams,
-  IItem
-} from "@esri/arcgis-rest-request/src";
-
-import { getPortalUrl } from "../util/get-portal-url";
-import { SearchQueryBuilder } from "./SearchQueryBuilder";
-
-export interface ISearchRequestOptions extends IRequestOptions, IPagingParams {
-  q: string | SearchQueryBuilder;
-  sortField?: string;
-  sortDir?: string;
-  [key: string]: any;
-}
-
-/**
- * Options to pass through when searching for items.
- */
-export interface ISearchResult {
-  query: string; // matches the api's form param
-  total: number;
-  start: number;
-  num: number;
-  nextStart: number;
-  results: IItem[];
-  nextPage?: () => Promise<ISearchResult>;
-}
+import { SearchQueryBuilder } from "../util/SearchQueryBuilder";
+import { ISearchRequestOptions, ISearchResult } from "../util/search";
+import { genericSearch } from "../util/generic-search";
 
 /**
  * ```js
@@ -47,50 +20,5 @@ export interface ISearchResult {
 export function searchItems(
   search: string | ISearchRequestOptions | SearchQueryBuilder
 ): Promise<ISearchResult> {
-  let options: IRequestOptions;
-  if (typeof search === "string" || search instanceof SearchQueryBuilder) {
-    options = {
-      httpMethod: "GET",
-      params: {
-        q: search
-      }
-    };
-  } else {
-    options = appendCustomParams<ISearchRequestOptions>(
-      search,
-      ["q", "num", "start", "sortField", "sortDir"],
-      {
-        httpMethod: "GET"
-      }
-    );
-  }
-
-  // construct the search url
-  const url = `${getPortalUrl(options)}/search`;
-
-  // send the request
-  return request(url, options).then(r => {
-    if (r.nextStart && r.nextStart !== -1) {
-      r.nextPage = function() {
-        let newOptions: ISearchRequestOptions;
-
-        if (
-          typeof search === "string" ||
-          search instanceof SearchQueryBuilder
-        ) {
-          newOptions = {
-            q: search,
-            start: r.nextStart
-          };
-        } else {
-          newOptions = search;
-          newOptions.start = r.nextStart;
-        }
-
-        return searchItems(newOptions);
-      };
-    }
-
-    return r;
-  });
+  return genericSearch(search, "item");
 }

packages/arcgis-rest-portal/src/items/SearchQueryBuilder.ts → packages/arcgis-rest-portal/src/util/SearchQueryBuilder.ts

@@ -1,4 +1,4 @@
-import { IParamBuilder, warn } from "@esri/arcgis-rest-request/src";
+import { IParamBuilder, warn } from "@esri/arcgis-rest-request";
 
 export class SearchQueryBuilder implements IParamBuilder {
   private termStack: any[] = [];

packages/arcgis-rest-portal/src/util/generic-search.ts

@@ -0,0 +1,66 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import {
+  request,
+  IRequestOptions,
+  appendCustomParams
+} from "@esri/arcgis-rest-request";
+
+import { SearchQueryBuilder } from "./SearchQueryBuilder";
+import { getPortalUrl } from "../util/get-portal-url";
+import { ISearchRequestOptions, ISearchResult } from "../util/search";
+
+export function genericSearch(
+  search: string | ISearchRequestOptions | SearchQueryBuilder,
+  searchType: "item" | "group"
+): Promise<ISearchResult> {
+  let url: string;
+  let options: IRequestOptions;
+  if (typeof search === "string" || search instanceof SearchQueryBuilder) {
+    options = {
+      httpMethod: "GET",
+      params: {
+        q: search
+      }
+    };
+  } else {
+    options = appendCustomParams<ISearchRequestOptions>(
+      search,
+      ["q", "num", "start", "sortField", "sortDir", "sortOrder"],
+      {
+        httpMethod: "GET"
+      }
+    );
+  }
+
+  searchType === "item"
+    ? (url = `${getPortalUrl(options)}/search`)
+    : (url = `${getPortalUrl(options)}/community/groups`);
+
+  // send the request
+  return request(url, options).then(r => {
+    if (r.nextStart && r.nextStart !== -1) {
+      r.nextPage = function() {
+        let newOptions: ISearchRequestOptions;
+
+        if (
+          typeof search === "string" ||
+          search instanceof SearchQueryBuilder
+        ) {
+          newOptions = {
+            q: search,
+            start: r.nextStart
+          };
+        } else {
+          newOptions = search;
+          newOptions.start = r.nextStart;
+        }
+
+        return genericSearch(newOptions, searchType);
+      };
+    }
+
+    return r;
+  });
+}

packages/arcgis-rest-portal/src/util/search.ts

@@ -0,0 +1,31 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import {
+  IRequestOptions,
+  IPagingParams,
+  IItem,
+  IGroup
+} from "@esri/arcgis-rest-request";
+
+import { SearchQueryBuilder } from "./SearchQueryBuilder";
+
+export interface ISearchRequestOptions extends IRequestOptions, IPagingParams {
+  q: string | SearchQueryBuilder;
+  sortField?: string;
+  sortDir?: string;
+  [key: string]: any;
+}
+
+/**
+ * Results from an item or group search.
+ */
+export interface ISearchResult {
+  query: string; // matches the api's form param
+  total: number;
+  start: number;
+  num: number;
+  nextStart: number;
+  results: IItem[] | IGroup[];
+  nextPage?: () => Promise<ISearchResult>;
+}

packages/arcgis-rest-portal/test/groups/search.test.ts

@@ -2,8 +2,8 @@
  * Apache-2.0 */
 
 import { searchGroups } from "../../src/groups/search";
-
 import { GroupSearchResponse } from "../mocks/groups/responses";
+import { SearchQueryBuilder } from "../../src/util/SearchQueryBuilder";
 
 import * as fetchMock from "fetch-mock";
 
@@ -14,8 +14,8 @@ describe("groups", () => {
     it("should make a simple, unauthenticated group search request", done => {
       fetchMock.once("*", GroupSearchResponse);
 
-      searchGroups({ q: "water" })
-        .then(response => {
+      searchGroups("water")
+        .then(() => {
           expect(fetchMock.called()).toEqual(true);
           const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
           expect(url).toEqual(
@@ -42,7 +42,7 @@ describe("groups", () => {
           expect(fetchMock.called()).toEqual(true);
           const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
           expect(url).toEqual(
-            "https://www.arcgis.com/sharing/rest/community/groups?f=json&q=water&start=4&num=7&sortField=owner&sortOrder=desc"
+            "https://www.arcgis.com/sharing/rest/community/groups?f=json&q=water&num=7&start=4&sortField=owner&sortOrder=desc"
           );
           expect(options.method).toBe("GET");
           done();
@@ -53,6 +53,31 @@ describe("groups", () => {
     });
   });
 
+  it("should make a simple, single search request with a builder", done => {
+    fetchMock.once("*", GroupSearchResponse);
+    const expectedParam = "Trees AND owner: USFS";
+    const q = new SearchQueryBuilder()
+      .match("Trees")
+      .and()
+      .match("USFS")
+      .in("owner");
+    searchGroups(q)
+      .then(() => {
+        expect(fetchMock.called()).toEqual(true);
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual(
+          `https://www.arcgis.com/sharing/rest/community/groups?f=json&q=${encodeURIComponent(
+            expectedParam
+          )}`
+        );
+        expect(options.method).toBe("GET");
+        done();
+      })
+      .catch(e => {
+        fail(e);
+      });
+  });
+
   describe("authenticted methods", () => {
     const MOCK_AUTH = {
       getToken() {
@@ -67,7 +92,7 @@ describe("groups", () => {
     it("should make a simple, authenticated group search request", done => {
       fetchMock.once("*", GroupSearchResponse);
 
-      searchGroups({ q: "water" }, MOCK_REQOPTS)
+      searchGroups({ q: "water", authentication: MOCK_AUTH })
         .then(response => {
           expect(fetchMock.called()).toEqual(true);
           const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");

packages/arcgis-rest-portal/test/items/search.test.ts

@@ -8,7 +8,7 @@ import { searchItems } from "../../src/items/search";
 import { SearchResponse, BigSearchResponse } from "../mocks/items/search";
 import { UserSession } from "@esri/arcgis-rest-auth";
 import { TOMORROW } from "@esri/arcgis-rest-auth/test/utils";
-import { SearchQueryBuilder } from "../../src/items/SearchQueryBuilder";
+import { SearchQueryBuilder } from "../../src/util/SearchQueryBuilder";
 
 describe("search", () => {
   afterEach(fetchMock.restore);

packages/arcgis-rest-portal/test/mocks/groups/responses.ts

@@ -1,15 +1,15 @@
 /* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
  * Apache-2.0 */
 
-import { IGroupSearchResult } from "../../../src/groups/search";
+import { ISearchResult } from "../../../src/util/search";
 import {
   IGroupContentResult,
   IGroupUsersResult
 } from "../../../src/groups/get";
 
 import { IGroup } from "@esri/arcgis-rest-request";
 
-export const GroupSearchResponse: IGroupSearchResult = {
+export const GroupSearchResponse: ISearchResult = {
   query: "* AND owner:dcadmin",
   total: 358,
   start: 1,

packages/arcgis-rest-portal/test/mocks/items/search.ts

@@ -1,7 +1,7 @@
 /* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
  * Apache-2.0 */
 
-import { ISearchResult } from "../../../src/items/search";
+import { ISearchResult } from "../../../src/util/search";
 
 export const SearchResponse: ISearchResult = {
   query: "",