aspernaturalias 1.0.0

package/docs/src/guides/package-overview.md

@@ -0,0 +1,111 @@
+---
+title: Package Overview
+description: Overview of packages provided by ArcGIS REST JS.
+order: 10
+group: 0-introduction
+---
+
+# Why `@esri/arcgis-rest-js`?
+
+`@esri/arcgis-rest-js` simplifies making requests to ArcGIS Online and Enterprise in both browsers and Node.js.
+
+There's no better way to explain what that means than comparing an `@esri/arcgis-rest-js` call to the same web request made using plain old JavaScript.
+
+### @esri/arcgis-rest
+
+```js
+import { getUser } from "@esri/arcgis-rest-portal";
+
+// pass in a username and get back information about the user
+getUser(`jgravois`)
+  .then(response) // { firstName: "john", description: "open source geodev" ... }
+```
+
+### vs. Vanilla JavaScript
+
+```js
+// construct the url yourself and don't forget to tack on f=json
+const url = "https://www.arcgis.com/sharing/rest/community/users/jgravois?f=json";
+
+var xhr = new XMLHttpRequest();
+xhr.onreadystatechange = function() {
+  if (xhr.readyState == XMLHttpRequest.DONE) {
+    xhr.responseText; // { firstName: "john", description: "open source geodev" ... }
+  }
+}
+xhr.open('GET', url, true);
+xhr.send(null);
+```
+
+wow, thats a lot easier! `@esri/arcgis-rest-js` is able to intuit the actual url (by default it assumes you're interacting with ArcGIS Online) prior to making the request and internalizes a lot of tedious logic for handling the response.
+
+Our packages tap into a new JavaScript spec called [`fetch()`](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch) under the hood though, so lets compare 🍎s to 🍎s.
+
+```js
+import { deleteFeatures } from "@esri/arcgis-rest-feature-layer";
+
+const url = `http://sampleserver6.arcgisonline.com/arcgis/rest/services/SF311/FeatureServer/1/`
+
+// https://esri.github.io/arcgis-rest-js/api/feature-service/deleteFeatures/
+deleteFeatures({
+  url,
+  objectIds: [ 2360245 ]
+})
+  .then(response)
+```
+
+```js
+// append operation name to url
+url += `deleteFeatures`;
+
+fetch(url, {
+  // set the request type
+  method: "POST",
+  // append appropriate headers
+  headers: {
+    "Content-Type": "application/x-www-form-urlencoded"
+  },
+  // concatentate and encode each parameter manually
+  // and remember to append f=json
+  body: `objectIds=${encodeURIComponent(2360245)}&f=json`
+})
+  .then(response => {
+    // cast the response as JSON
+    if (response.ok) {
+      return response.json()
+    }
+  })
+  .then(response => {
+    // trap for ArcGIS error objects in 200 responses
+    if (!response.error) {
+      console.log(response);
+    }
+  })
+```
+
+As you can see, `@esri/arcgis-rest-js` is still handling a _lot_ of the details internally.
+
+* the operation name is appended to urls
+* a `"POST"` is made automatically (when appropriate)
+* query string parameters are encoded
+* appropriate `headers` are appended
+* `FormData` is created internally (when necessary)
+* `200` responses that contain an error are trapped for
+* the generic `f=json` parameter is appended
+
+And we haven't even begun to discuss [authentication](../browser-authentication/).
+
+Whether you're trying to automate interacting with premium services in Node.js or creating a website that will allow users to sign into [ArcGIS Online](https://www.arcgis.com) safely and manage their own content, `@esri/arcgis-rest-js` has you covered.
+
+# Package Overview
+
+The library is a collection of _very_ small mix and match packages that are framework agnostic and make a variety of ArcGIS tasks more convenient.
+
+* [`@esri/arcgis-rest-request`](./packages/arcgis-rest-request/) - Underpins other packages and supports making low-level requests.
+* [`@esri/arcgis-rest-auth`](./packages/arcgis-rest-auth) - Provides methods for authenticating named users and applications.
+* [`@esri/arcgis-rest-portal`](./packages/arcgis-rest-portal) - Methods for working with ArcGIS Online/Enterprise content and users.
+* [`@esri/arcgis-rest-feature-layer`](./packages/arcgis-rest-feature-layer) - Functions for querying and editing features inside of hosted feature layers.
+* [`@esri/arcgis-rest-service-admin`](./packages/arcgis-rest-feature-service-admin) - Functions for administering hosted services.
+* [`@esri/arcgis-rest-geocoding`](./packages/arcgis-rest-geocoding) - Geocoding wrapper for `@esri/arcgis-rest-js`
+* [`@esri/arcgis-rest-routing`](./packages/arcgis-rest-routing) - Routing and directions wrapper for `@esri/arcgis-rest-js`.
+* [`@esri/arcgis-rest-types`](./packages/arcgis-rest-request/) - Common Typings for TypeScript developers.

package/docs/src/guides/server-authentication.md

@@ -0,0 +1,9 @@
+---
+title: Server-based authentication with ArcGIS REST JS
+navTitle: Server-based OAuth 2.0
+description: Learn how to authenticate users with ArcGIS REST JS and OAuth 2.0 in a Node.js server.
+order: 10
+group: 2-authentication
+---
+
+# Authentication in Server-based Apps

package/docs/src/guides/whats-new-v2-0.md

@@ -0,0 +1,305 @@
+---
+title: What's New in v2.0.0
+navTitle: What's New in v2.0.0
+description: Learn what's new in v2.0.0 of ArcGIS REST JS.
+order: 60
+group: 1-get-started
+---
+
+# What's new in `v2.0.0?`
+
+Our family of users and contributors has grown [(a lot!)](https://github.com/Esri/arcgis-rest-js/blob/master/docs/FAQ.md#who-is-using-these-packages) since our first release so we decided to rollup our sleeves (groan) and overhaul the API. Our goals were to:
+
+1. Make ArcGIS REST JS as consistent (and simple) as possible
+2. Introduce building blocks for compositional/fluent APIs
+3. Provide a few new options to reuse common parameters
+
+## Fluent APIs
+
+In [`v2.0.0`](https://github.com/Esri/arcgis-rest-js/releases/v2.0.0) we introduced a new class called [`SearchQueryBuilder`](../../api/portal/SearchQueryBuilder/) to help compose complex parameters.
+
+```ts
+import { searchItems, SearchQueryBuilder } from "@esri/arcgis-rest-portal";
+
+const q = new SearchQueryBuilder()
+  .match("Trees")
+  .and()
+  .match("US Forest Service")
+  .in("owner")
+  .and()
+  .startGroup()
+   .match("Web Mapping Application")
+   .in("type")
+   .or()
+   .match("Mobile Application")
+   .in("type")
+ .endGroup()
+
+// "Trees AND owner: US Forest Service AND (type: "Web Mapping Application" OR type: "Mobile Application")"
+searchItems({ q })
+```
+
+Currently only [`searchItems()`](../../api/portal/searchItems/) and [`searchGroups()`](../../api/portal/searchGroups/) accept `SearchQueryBuilder` as an input, but we've included building blocks (groan) to create additional implementations as well.
+
+## Paging
+
+The promises returned by [`searchItems()`](../../api/portal/searchItems/) and [`searchGroups()`](../../api/portal/searchGroups/) also got a handy new [`nextPage()`](../../api/portal/searchItems/#nextPage) method to make it easier to sift through paginated results.
+
+```ts
+searchItems({ q })
+  .then(response => {
+    if (response.nextPage) {
+      r.nextPage()
+        .then(responsePageTwo)
+    }
+  })
+```
+
+## Reuse parameters
+
+We added two new methods to `@esri/arcgis-rest-request` as helpers for passing repeat options through.
+
+### [`setDefaultRequestOptions()`](../../api/request/setDefaultRequestOptions/)
+
+Now, if you want to ensure that _all_ requests include a custom option, you can use `setDefaultRequestOptions()`.
+
+```ts
+import { request, setDefaultRequestOptions } from "@esri/arcgis-rest-request";
+
+setDefaultRequestOptions({
+  headers: { "Custom-Header": "Test Value" }
+});
+
+const url = `https://www.arcgis.com/sharing/rest/info`;
+
+// the custom header will *always* be passed along
+request(url)
+```
+
+You should _not_ pass `authentication` to this method if your code runs in a shared environment like a web server that handles requests for more than one user.
+
+### [`withOptions()`](../../api/request/withOptions/)
+
+If you'd like to selectively append common options to _a specific method_, you can use the new `withOptions()` method.
+
+```ts
+import { request, withOptions } from "@esri/arcgis-rest-request";
+
+const authenticatedRequest = withOptions({
+  authentication: session
+}, request);
+
+// includes authenticated session
+authenticatedRequest(url)
+
+// does NOT include authenticated session
+request(url)
+```
+
+## Breaking Changes
+
+In order to make the API more consistent and a little easier to navigate, we had to break a few 🍳s.
+
+#### One `portal` package to rule them all (even for ArcGIS Online)
+
+We consolidated four existing packages into a new one called [`@esri/arcgis-rest-portal`](../../api/portal/). Whether you want to talk to ArcGIS Online _or_ Enterprise, now you'll do this:
+```bash
+# new
+npm install @esri/arcgis-rest-portal
+```
+instead of this:
+```bash
+# old
+npm install @esri/arcgis-rest-items &&
+@esri/arcgis-rest-users &&
+@esri/arcgis-rest-groups &&
+@esri/arcgis-rest-sharing
+```
+The table below lists methods in this package that have been deprecated, given a facelift, or given a new home.
+
+| Old | New | Package
+| -- | -- | -- |
+| ~~`serializeGroup()`~~ |  | ~~`groups`~~ |
+| ~~`addItemJsonData()`~~ | [`addItemData()`](https://esri.github.io/arcgis-rest-js/api/portal/addItemData/) | ~~`items`~~ |
+| ~~`createItemInFolder({ folder })`~~ | [`createItemInFolder({ folderId })`](https://esri.github.io/arcgis-rest-js/api/portal/createItemInFolder/) | ~~`items`~~ `portal` |
+| ~~`searchItems( string|opts )`~~ | [`searchItems( string|opts|Builder )`](https://esri.github.io/arcgis-rest-js/api/portal/searchItems/) | ~~`items`~~ `portal` |
+| ~~`searchGroups( form, opts )`~~ | [`searchGroups( string|opts|Builder )`](https://esri.github.io/arcgis-rest-js/api/portal/searchGroups/) | ~~`groups`~~ `portal` |
+| ~~`getItemResources( opts )`~~ | [`getItemResources( id, opts? )`](https://esri.github.io/arcgis-rest-js/api/portal/getItemResources/) | ~~`items`~~ `portal` |
+| `getUserUrl()` | [`getUserUrl()`](https://esri.github.io/arcgis-rest-js/api/portal/getUserUrl/) | ~~`auth`~~ `portal` |
+| `getPortalUrl()` | [`getPortalUrl()`](https://esri.github.io/arcgis-rest-js/api/portal/getPortalUrl/) | ~~`request`~~ `portal` |
+| `getPortal()` | [`getPortal()`](https://esri.github.io/arcgis-rest-js/api/portal/getPortal/) | ~~`request`~~ `portal` |
+|  | [`SearchQueryBuilder`](https://esri.github.io/arcgis-rest-js/api/portal/SearchQueryBuilder/) | `portal` |
+
+#### `@esri/arcgis-rest-request`
+
+The only breaking changes we made to `request` were to refactor an internal method and move a couple others into the new [`portal`](../../api/portal/) package.
+
+| Old | New | Package Name |
+| -- | -- | -- |
+| `getPortalUrl()` | [`getPortalUrl()`](https://esri.github.io/arcgis-rest-js/api/portal/getPortalUrl/) | ~~`request`~~ `portal` |
+| `getPortal()` | [`getPortal()`](https://esri.github.io/arcgis-rest-js/api/portal/getPortal/) | ~~`request`~~ `portal` |
+
+#### If you work with private services (shhhh)
+
+We didn't make many changes in `@esri/arcgis-rest-auth`, but one method moved and two others got simpler.
+
+| Old | New | Package Name |
+| -- | -- | -- |
+| `getUserUrl()` | [`getUserUrl()`](https://esri.github.io/arcgis-rest-js/api/portal/getUserUrl/) | ~~`auth`~~ `portal` |
+| `fetchToken(params|opts)` | `fetchToken(opts)` |
+| `generateToken(params|opts)` | `generateToken(opts)` |
+
+#### `@esri/arcgis-rest-routing`
+
+In this package, we renamed one constant.
+
+| Old | New |
+| -- | -- |
+| ~~`worldRoutingService`~~ | [`ARCGIS_ONLINE_ROUTING_URL`](https://esri.github.io/arcgis-rest-js/api/routing/ARCGIS_ONLINE_ROUTING_URL/) |
+
+#### Geocoding addresses
+
+In the interest of consistency, we renamed the geocoding package too.
+
+```bash
+# new
+npm install @esri/arcgis-rest-geocoding
+```
+
+```bash
+# old
+npm install @esri/arcgis-rest-geocoder
+```
+
+We renamed one method (and one constant) as well.
+
+| Old | New |
+| -- | -- |
+| ~~`serviceInfo()`~~ | [`getGeocodeService()`](https://esri.github.io/arcgis-rest-js/api/geocoding/getGeocodeService/) |
+| ~~`worldGeocoder`~~ | [`ARCGIS_ONLINE_GEOCODING_URL`](https://esri.github.io/arcgis-rest-js/api/geocoding/ARCGIS_ONLINE_GEOCODING_URL/) |
+
+#### Querying and editing feature layers
+
+This package was also renamed. If you're already using `queryFeatures()` or making edits inside hosted feature layers, now you'll install this:
+
+```bash
+# new
+npm install @esri/arcgis-rest-feature-layer
+```
+
+instead of this:
+```bash
+# old
+npm install @esri/arcgis-rest-feature-service
+```
+The `feature-layer` methods that were refactored or re-homed are listed below.
+
+| Old | New | Package |
+| -- | -- | -- |
+| ~~`addFeatures({ adds })`~~ | [`addFeatures({ features })`](https://esri.github.io/arcgis-rest-js/api/feature-layer/addFeatures/) |
+| ~~`updateFeatures({ updates })`~~ | [`updateFeatures({ features })`](https://esri.github.io/arcgis-rest-js/api/feature-layer/updateFeatures/) |
+| ~~`deleteFeatures({ deletes })`~~ | [`deleteFeatures({ objectIds })`](https://esri.github.io/arcgis-rest-js/api/feature-layer/deleteFeatures/) |
+| ~~`getLayer(url, options)`~~ | [`getLayer(options)`](https://esri.github.io/arcgis-rest-js/api/feature-layer/getLayer/) |
+
+#### Publishing and updating new hosted feature services
+
+If you're already using `rest-js` to publish _new_ hosted feature services, that package has a new (shorter) name too.
+
+```bash
+# new
+npm install @esri/arcgis-rest-service-admin
+```
+instead of this:
+```bash
+# old
+npm install @esri/arcgis-rest-feature-service-admin
+```
+After you save those seven keystrokes, everything else will be familiar.
+
+#### Helper methods
+
+In this release we also made the decision to stop documenting internal helper methods like `appendCustomParams`. In the future, undocumented methods may change without notice.
+
+## Breaking Changes for TypeScript developers
+
+Each package now installs shared TypeScript typings automatically and  re-exports them, so its no longer necessary to install a separate package yourself.
+
+```ts
+// old
+import { IPoint } from "@esri/arcgis-rest-common-types";
+import { reverseGeocode } from "@esri/arcgis-rest-geocoder";
+
+reverseGeocode({ x: 34, y: -118} as IPoint);
+
+// new
+import { IPoint, reverseGeocode } from "@esri/arcgis-rest-geocoding";
+
+reverseGeocode({ x: 34, y: -118} as IPoint);
+```
+
+If you'd _like_ to install the typings yourself, there is a more concise package name for that too.
+
+```bash
+# new package name
+npm install @esri/arcgis-rest-types
+```
+
+The table below lists interfaces and types that have been removed or renamed in the name of consistency and brevity. This also better aligns the names of options and response interfaces with their corresponding  function.
+
+| Old Interface/Type | New Interface/Type |
+| -- | -- |
+| ~~`esriFieldTypes`~~ | `FieldTypes` |
+| ~~`esriGeometryType`~~ | `GeometryType` |
+| ~~`esriUnits`~~ | `Units` |
+| ~~`IOauth2Options`~~ | `IOAuth2Options` |
+| ~~`IBulkGeocodingRequestOptions`~~ | `IBulkGeocodeOptions` |
+| ~~`IGeocodeRequestOptions`~~ | `IGeocodeOptions` |
+| ~~`IGeocodeParams`~~ |  |
+| ~~`ISolveRouteRequestOptions`~~ | `ISolveRouteOptions` |
+| ~~`IEditFeaturesParams`~~ | `ISharedEditOptions` |
+| ~~`IQueryFeaturesParams`~~ | `ISharedQueryOptions` |
+| ~~`IQueryFeaturesRequestOptions`~~ | `IQueryFeaturesOptions` |
+| ~~`IQueryRelatedRequestOptions`~~ | `IQueryRelatedOptions` |
+| ~~`IAddFeaturesRequestOptions`~~ | `IAddFeaturesOptions` |
+| ~~`IUpdateFeaturesRequestOptions`~~ | `IUpdateFeaturesOptions` |
+| ~~`IDeleteFeaturesRequestOptions`~~ | `IDeleteFeaturesOptions` |
+| ~~`IDecodeValuesRequestOptions`~~ | `IDecodeValuesOptions` |
+| ~~`ILayerRequestOptions`~~ | `IGetLayerOptions` |
+| ~~`IFeatureRequestOptions`~~ | `IGetFeatureOptions` |
+| ~~`IAddToServiceDefinitionRequestOptions`~~ | `IAddToServiceDefinitionOptions` |
+| ~~`ICreateServiceRequestOptions`~~ | `ICreateServiceOptions` |
+| ~~`IItemResourceAddRequestOptions`~~ |  |
+| ~~`IGroupAddRequestOptions`~~ | `ICreateGroupOptions` |
+| ~~`IPagingParamsRequestOptions`~~ | `IGetGroupContentOptions` |
+| ~~`IGroupIdRequestOptions`~~ | `IUserGroupOptions` |
+| ~~`IGroupNotificationRequestOptions`~~ | `ICreateGroupNotificationOptions` |
+| ~~`ISearchRequestOptions`~~ | `ISearchOptions` |
+| ~~`IGroupUpdateRequestOptions`~~ | `IUpdateGroupOptions` |
+| ~~`IItemIdRequestOptions`~~ | `IUserItemOptions` |
+| ~~`IItemResourceRequestOptions`~~ | `IItemResourceOptions` |
+| ~~`IItemAddResponse`~~ | `ICreateItemResponse` |
+| ~~`IManageItemRelationshipRequestOptions`~~ | `IManageItemRelationshipOptions` |
+| ~~`IItemDataAddRequestOptions`~~ | `IAddItemDataOptions` |
+| ~~`IItemCrudRequestOptions`~~ | `ICreateUpdateItemOptions` |
+| ~~`IAddFolderRequestOptions`~~ | `ICreateFolderOptions` |
+| ~~`IItemAddRequestOptions`~~ | `ICreateItemOptions` |
+| ~~`IItemDataRequestOptions`~~ | `IItemDataOptions` |
+| ~~`IItemRelationshipRequestOptions`~~ | `IItemRelationshipOptions` |
+| ~~`IItemGroupResponse`~~ | `IGetItemGroupsResponse` |
+| ~~`IItemRequestOptions`~~ |  |
+| ~~`IFolderIdRequestOptions`~~ | `IFolderIdOptions` |
+| ~~`IItemUpdateResponse`~~ | `IUpdateItemResponse` |
+| ~~`IItemMoveResponse`~~ | `IMoveItemResponse` |
+| ~~`IItemUpdateRequestOptions`~~ | `IUpdateItemOptions` |
+| ~~`IItemMoveRequestOptions`~~ | `IMoveItemOptions` |
+| ~~`ISharingRequestOptions`~~ | `ISharingOptions` |
+| ~~`ISetAccessRequestOptions`~~ | `ISetAccessOptions` |
+| ~~`IGroupSharingRequestOptions`~~ | `IGroupSharingOptions` |
+| ~~`IGetUserRequestOptions`~~ | `IGetUserOptions` |
+| ~~`IInvitationRequestOptions`~~ | `IGetUserInvitationOptions` |
+| ~~`INotificationIdRequestOptions`~~ | `IRemoveNotificationOptions` |
+| ~~`IUpdateUserRequestOptions`~~ | `IUpdateUserOptions` |
+|  | `IParamBuilder` |
+|  | `IParamsBuilder` |
+
+That's it! We know that moving so much 🧀 is a hassle, but developers of the future send their thanks! 🎩

package/docs/src/index.html

@@ -0,0 +1,12 @@
+
+<header class="sub-nav" role="banner">
+  <div class="grid-container">
+    <div class="column-24 text-center leader-4 trailer-5">
+      <h1 class="font-size-7 text-white">ArcGIS REST JS</h1>
+      <p class="text-white font-size-2">Compact, modular JavaScript wrappers for the ArcGIS REST API</a>.</p>
+      {% link "./guides/", "Get Started", class="btn btn-large btn-clear-white" %}
+      {% link "./api/", "API Reference", class="btn btn-large btn-clear-white" %}
+    </div>
+  </div>
+</header>
+</div>

package/docs/src/js/api-search.js

@@ -0,0 +1,112 @@
+Vue.component("api-search", {
+  template: `
+    <div>
+      <form v-on:submit.prevent="onSubmit" class="input-group trailer-half leader-0">
+        <input ref="input" v-model="searchTerm" v-on:keyup.enter="onSubmit" v-on:keyup.up="onSelectPrevious" v-on:keyup.down="onSelectNext" v-on:keyup="onChange" class="input-group-input" type="text" placeholder="Search the API Reference">
+        <span class="input-group-button">
+          <button type="submit" class="btn"><svg xmlns="http://www.w3.org/2000/svg" width="32" height="32" viewBox="0 0 32 32" class="svg-icon"><path d="M31.607 27.838l-6.133-6.137a1.336 1.336 0 0 0-1.887 0l-.035.035-2.533-2.533-.014.014c3.652-4.556 3.422-11.195-.803-15.42-4.529-4.527-11.875-4.531-16.404 0-4.531 4.531-4.529 11.875 0 16.406 4.205 4.204 10.811 4.455 15.365.848l.004.003-.033.033 2.541 2.54a1.33 1.33 0 0 0 .025 1.848l6.135 6.133a1.33 1.33 0 0 0 1.887 0l1.885-1.883a1.332 1.332 0 0 0 0-1.887zM17.811 17.809a8.213 8.213 0 0 1-11.619 0 8.217 8.217 0 0 1 0-11.622 8.219 8.219 0 0 1 11.619.004 8.216 8.216 0 0 1 0 11.618z"/></svg></button>
+        </span>
+      </form>
+
+      <div class="panel" v-show="results.length <= 0 && searchTerm">
+        No Results.
+      </div>
+
+      <div v-show="results.length <= 0 && !searchTerm">
+        <slot></slot>
+      </div>
+
+      <ul v-show="results.length > 0" class="list-plain">
+        <li v-for="result, index in results" class="api-search-result api-list-item" v-bind:class="[result.icon, {'is-selected': index === selectedResultIndex}]">
+          <a v-bind:href="result.url" class="tsd-kind-icon" v-html="result.title"></a>
+        </li>
+      </ul>
+    </div>
+    </div>
+  `,
+  data: function() {
+    return {
+      results: [],
+      selectedResultIndex: 0,
+      searchTerm: ""
+    };
+  },
+  methods: {
+    highlightText: function(text, matches) {
+      return matches
+        .map(match => {
+          let characters = text.split("");
+
+          for (let i = match.indices.length - 1; i >= 0; i--) {
+            let start = match.indices[i][0];
+            let end = match.indices[i][1] + 1;
+            let foundMatch = characters.slice(start, end).join("");
+            characters.splice(
+              start,
+              end - start,
+              `<span style="text-decoration: underline; font-weight: 500;">${foundMatch}</span>`
+            );
+          }
+
+          return characters.join("");
+        })
+        .join();
+    },
+    onSubmit: function() {
+      if (this.results.length && this.results[this.selectedResultIndex]) {
+        window.location.href = this.results[this.selectedResultIndex].url;
+      }
+    },
+
+    search: function(text) {
+      return this.index.search(text).map(result => {
+        return {
+          title: this.highlightText(result.item.title, result.matches),
+          icon: result.item.icon,
+          url: result.item.url
+        };
+      });
+    },
+
+    onChange: function(e) {
+      this.results = this.search(e.target.value);
+
+      if (e.keyCode === 38 || e.keyCode === 40) {
+        e.preventDefault();
+        e.stopPropagation();
+      }
+    },
+
+    onSelectNext: function(e) {
+      this.selectedResultIndex =
+        this.selectedResultIndex === this.results.length - 1
+          ? 0
+          : this.selectedResultIndex + 1;
+      e.preventDefault();
+      e.stopPropagation();
+    },
+
+    onSelectPrevious: function(e) {
+      this.selectedResultIndex =
+        this.selectedResultIndex === 0
+          ? this.results.length - 1
+          : this.selectedResultIndex - 1;
+
+      e.preventDefault();
+      e.stopPropagation();
+    }
+  },
+  created: function() {
+    this.index = new Fuse(ESRI_REST_API_REF_INDEX, {
+      shouldSort: true,
+      threshold: 0.25,
+      location: 0,
+      distance: 200,
+      maxPatternLength: 32,
+      minMatchCharLength: 2,
+      findAllMatches: true,
+      includeMatches: true,
+      keys: ["title"]
+    });
+  }
+});

package/docs/src/js/nav-toggle.js

@@ -0,0 +1,41 @@
+Vue.component("nav-toggle", {
+  props: ["index", "packageName"],
+  mounted: function() {
+    this.trigger = document.getElementById("trigger" + this.index);
+    this.list = document.getElementById("list" + this.index);
+    this.toggle = false;
+
+    const match = window.location.pathname.match(/\/api\/([^\/]+)\//);
+    const partialPath = match ? match[1] : null;
+    if (partialPath && this.packageName.replace("@esri/arcgis-rest-", "") === partialPath) {
+      this.show();
+    }
+
+    this.trigger.onclick = () => {
+      if (this.toggle) {
+        this.hide();
+      } else {
+        this.show();
+      }
+    };
+  },
+  methods: {
+    hide: function() {
+      for (var i = 0; i < this.list.children.length; i++) {
+        this.trigger.innerHTML = `<svg xmlns="http://www.w3.org/2000/svg" width="32" height="32" viewBox="0 0 32 32" class="svg-icon"><path d="M7 4h5l12 12-12 12H7l12-12L7 4z"/></svg>`;
+        this.list.children[i].classList.add("visually-hidden");
+      }
+      this.toggle = false;
+    },
+    show: function() {
+      for (var i = 0; i < this.list.children.length; i++) {
+        this.trigger.innerHTML = `<svg xmlns="http://www.w3.org/2000/svg" width="32" height="32" viewBox="0 0 32 32" class="svg-icon"><path d="M28 9v5L16 26 4 14V9l12 12L28 9z"/></svg>`;
+        this.list.children[i].classList.remove("visually-hidden");
+        if (this.list.children[i].children[0].classList.contains("is-active")) {
+          this.list.children[i].classList.add("list-item-active");
+        }
+      }
+      this.toggle = true;
+    }
+  }
+});