ducimusipsa 1.0.0

package/packages/arcgis-rest-routing/src/solveRoute.ts

@@ -0,0 +1,102 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { request } from "@esri/arcgis-rest-request";
+
+import {
+  ILocation,
+  ISpatialReference,
+  IPoint,
+  IFeature,
+  isLocation,
+  isLocationArray
+} from "@esri/arcgis-rest-common";
+
+import { worldRoutingService, IEndpointRequestOptions } from "./helpers";
+
+export interface ISolveRouteRequestOptions extends IEndpointRequestOptions {
+  /**
+   * Specify two or more locations between which the route is to be found.
+   */
+  stops: Array<IPoint | ILocation | [number, number]>;
+}
+
+export interface ISolveRouteResponse {
+  messages: string[];
+  checksum: string;
+  routes: {
+    fieldAliases: object;
+    geometryType: string;
+    spatialReference: ISpatialReference;
+    features: IFeature[];
+  };
+  directions?: Array<{
+    routeId: number;
+    routeName: string;
+    summary: object;
+    features: IFeature[];
+  }>;
+}
+
+/**
+ * Used to find the best way to get from one location to another or to visit several locations. See the [REST Documentation](https://developers.arcgis.com/rest/network/api-reference/route-synchronous-service.htm) for more information.
+ *
+ * ```js
+ *   import { solveRoute } from '@esri/arcgis-rest-routing';
+ *   import { ApplicationSession } from '@esri/arcgis-rest-auth';
+ *
+ *   solveRoute({
+ *      stops: [
+ *       [-117.195677, 34.056383],
+ *       [-117.918976, 33.812092],
+ *      ],
+ *      authentication: session
+ *   })
+ *   .then((response) => {
+ *     response.routes.features; // => {routes: {features: [{attributes: { ... }, geometry:{ ... }}]}}
+ *   });
+ * ```
+ *
+ * @param requestOptions Options to pass through to the routing service.
+ * @returns A Promise that will resolve with routes and directions for the request.
+ */
+export function solveRoute(
+  requestOptions: ISolveRouteRequestOptions
+): Promise<ISolveRouteResponse> {
+  const options: ISolveRouteRequestOptions = {
+    endpoint: requestOptions.endpoint || worldRoutingService,
+    params: {},
+    ...requestOptions
+  };
+
+  // the SAAS service does not support anonymous requests
+  if (
+    !requestOptions.authentication &&
+    options.endpoint === worldRoutingService
+  ) {
+    return Promise.reject(
+      "Routing using the ArcGIS service requires authentication"
+    );
+  }
+
+  const stops: string[] = requestOptions.stops.map(coords => {
+    if (isLocationArray(coords)) {
+      return coords.join();
+    } else if (isLocation(coords)) {
+      if (coords.lat) {
+        return coords.long + "," + coords.lat;
+      } else {
+        return coords.longitude + "," + coords.latitude;
+      }
+    } else {
+      return coords.y + "," + coords.x;
+    }
+  });
+  options.params.stops = stops.join(";");
+
+  return request(options.endpoint + "solve", options);
+}
+
+export default {
+  solveRoute
+};