fix(:bathtub:): remove magicKey from suggest, surface it more promine…

…ntly in geocode AFFECTS PACKAGES: @esri/arcgis-rest-geocoder ISSUES CLOSED: #459
Esri · Feb 14, 2019 · fb2ba9a · fb2ba9a
1 parent 9b2b67f
commit fb2ba9a
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 85 deletions.
diff --git a/packages/arcgis-rest-geocoder/src/geocode.ts b/packages/arcgis-rest-geocoder/src/geocode.ts
@@ -16,23 +16,6 @@ import {
 
 import { worldGeocoder, IEndpointRequestOptions } from "./helpers";
 
-export interface IGeocodeParams extends IParams {
-  /**
-   * You can create an autocomplete experience by making a call to suggest with partial text and then passing through the magicKey and complete address that are returned to geocode.
-   * ```js
-   * import { suggest, geocode } from '@esri/arcgis-rest-geocoder';
-   * suggest("LAX")
-   *   .then((response) => {
-   *     geocode({
-   *       singleLine: response.suggestions[1].text,
-   *       magicKey: response.suggestions[0].magicKey
-   *     })
-   *   })
-   * ```
-   */
-  magicKey?: string;
-}
-
 export interface IGeocodeRequestOptions extends IEndpointRequestOptions {
   /**
    * use this if all your address info is contained in a single string.
@@ -51,6 +34,20 @@ export interface IGeocodeRequestOptions extends IEndpointRequestOptions {
   postal?: number;
   postalExt?: number;
   countryCode?: string;
+  /**
+   * You can create an autocomplete experience by making a call to suggest with partial text and then passing through the magicKey and complete address that are returned to geocode.
+   * ```js
+   * import { suggest, geocode } from '@esri/arcgis-rest-geocoder';
+   * suggest("LAX")
+   *   .then((response) => {
+   *     geocode({
+   *       singleLine: response.suggestions[1].text,
+   *       magicKey: response.suggestions[0].magicKey
+   *     })
+   *   })
+   * ```
+   */
+  magicKey?: string;
 }
 
 export interface IGeocodeResponse {

diff --git a/packages/arcgis-rest-geocoder/src/suggest.ts b/packages/arcgis-rest-geocoder/src/suggest.ts
@@ -5,23 +5,6 @@ import { request, cleanUrl } from "@esri/arcgis-rest-request";
 
 import { worldGeocoder, IEndpointRequestOptions } from "./helpers";
 
-export interface ISuggestRequestOptions extends IEndpointRequestOptions {
-  /**
-   * You can create an autocomplete experience by making a call to suggest with partial text and then passing through the magicKey and complete address that are returned to geocode.
-   * ```js
-   * import { suggest, geocode } from '@esri/arcgis-rest-geocoder';
-   * suggest("LAX")
-   *   .then((response) => {
-   *     geocode({
-   *       singleLine: response.suggestions[1].text,
-   *       magicKey: response.suggestions[1].magicKey
-   *     })
-   *   })
-   * ```
-   */
-  magicKey?: string;
-}
-
 export interface ISuggestResponse {
   suggestions: Array<{
     text: string;
@@ -44,20 +27,16 @@ export interface ISuggestResponse {
  */
 export function suggest(
   partialText: string,
-  requestOptions?: ISuggestRequestOptions
+  requestOptions?: IEndpointRequestOptions
 ): Promise<ISuggestResponse> {
-  const options: ISuggestRequestOptions = {
+  const options: IEndpointRequestOptions = {
     endpoint: worldGeocoder,
     params: {},
     ...requestOptions
   };
 
   options.params.text = partialText;
 
-  if (requestOptions && requestOptions.magicKey) {
-    options.params.magicKey = requestOptions.magicKey;
-  }
-
   return request(`${cleanUrl(options.endpoint)}/suggest`, options);
 }
 

diff --git a/packages/arcgis-rest-geocoder/test/suggest.test.ts b/packages/arcgis-rest-geocoder/test/suggest.test.ts
@@ -29,28 +29,6 @@ describe("geocode", () => {
       });
   });
 
-  it("should make a request for suggestions with magic key", done => {
-    fetchMock.once("*", Suggest);
-
-    suggest("LAX", { magicKey: "foo" })
-      .then(response => {
-        expect(fetchMock.called()).toEqual(true);
-        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
-        expect(url).toEqual(
-          "https://geocode.arcgis.com/arcgis/rest/services/World/GeocodeServer/suggest"
-        );
-        expect(options.method).toBe("POST");
-        expect(options.body).toContain("f=json");
-        expect(options.body).toContain("text=LAX");
-        expect(options.body).toContain("magicKey=foo");
-        expect(response).toEqual(Suggest); // this introspects the entire response
-        done();
-      })
-      .catch(e => {
-        fail(e);
-      });
-  });
-
   it("should make a request for suggestions with other parameters", done => {
     fetchMock.once("*", Suggest);
 
@@ -72,27 +50,4 @@ describe("geocode", () => {
         fail(e);
       });
   });
-
-  it("should make a request for suggestions with magic key and other parameters", done => {
-    fetchMock.once("*", Suggest);
-
-    suggest("LAX", { magicKey: "foo", params: { category: "Address,Postal" } })
-      .then(response => {
-        expect(fetchMock.called()).toEqual(true);
-        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
-        expect(url).toEqual(
-          "https://geocode.arcgis.com/arcgis/rest/services/World/GeocodeServer/suggest"
-        );
-        expect(options.method).toBe("POST");
-        expect(options.body).toContain("f=json");
-        expect(options.body).toContain("text=LAX");
-        expect(options.body).toContain("magicKey=foo");
-        expect(options.body).toContain("category=Address%2CPostal");
-        expect(response).toEqual(Suggest); // this introspects the entire response
-        done();
-      })
-      .catch(e => {
-        fail(e);
-      });
-  });
 });