culparepellendus 1.0.0

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

@@ -0,0 +1,677 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { solveRoute } from "../src/solveRoute";
+
+import * as fetchMock from "fetch-mock";
+
+import { Solve, SolveNoDirections, SolveWebMercator } from "./mocks/responses";
+import { IPoint, ILocation, IFeatureSet } from "@esri/arcgis-rest-types";
+
+// -117.195677,34.056383;-117.918976,33.812092
+const stops: Array<[number, number]> = [
+  [-117.195677, 34.056383],
+  [-117.918976, 33.812092],
+];
+
+// -117.195677,34.056383,10.11;-117.918976,33.812092,8.43
+const stops3: Array<[number, number, number]> = [
+  [-117.195677, 34.056383, 10.11],
+  [-117.918976, 33.812092, 8.43],
+];
+
+const stopsObjectsLatLong: ILocation[] = [
+  {
+    lat: 34.056383,
+    long: -117.195677,
+  },
+  {
+    lat: 33.812092,
+    long: -117.918976,
+  },
+];
+
+const stopsObjectsLatLong3: ILocation[] = [
+  {
+    lat: 34.056383,
+    long: -117.195677,
+    z: 10.11,
+  },
+  {
+    lat: 33.812092,
+    long: -117.918976,
+    z: 8.43,
+  },
+];
+
+const stopsObjectsLatitudeLongitude: ILocation[] = [
+  {
+    latitude: 34.056383,
+    longitude: -117.195677,
+  },
+  {
+    latitude: 33.812092,
+    longitude: -117.918976,
+  },
+];
+
+const stopsObjectsLatitudeLongitude3: ILocation[] = [
+  {
+    latitude: 34.056383,
+    longitude: -117.195677,
+    z: 10.11,
+  },
+  {
+    latitude: 33.812092,
+    longitude: -117.918976,
+    z: 8.43,
+  },
+];
+
+const stopsObjectsPoint: IPoint[] = [
+  {
+    x: -117.195677,
+    y: 34.056383,
+  },
+  {
+    x: -117.918976,
+    y: 33.812092,
+  },
+];
+
+const stopsObjectsPoint3: IPoint[] = [
+  {
+    x: -117.195677,
+    y: 34.056383,
+    z: 10.11,
+  },
+  {
+    x: -117.918976,
+    y: 33.812092,
+    z: 8.43,
+  },
+];
+
+const stopsFeatureSet: IFeatureSet = {
+  features: [
+    {
+      geometry: {
+        x: -117.195677,
+        y: 34.056383,
+        spatialReference: {
+          wkid: 4326,
+        },
+      } as IPoint,
+      attributes: {},
+    },
+    {
+      geometry: {
+        x: -117.918976,
+        y: 33.812092,
+        spatialReference: {
+          wkid: 4326,
+        },
+      } as IPoint,
+      attributes: {},
+    },
+  ],
+};
+
+// const customRoutingUrl =
+//   "https://foo.com/ArcGIS/rest/services/Network/USA/NAServer/";
+
+describe("solveRoute", () => {
+  afterEach(fetchMock.restore);
+
+  it("should throw an error when a solveRoute request is made without a token", (done) => {
+    fetchMock.once("*", Solve);
+
+    solveRoute({
+      stops,
+    })
+      // tslint:disable-next-line
+      .catch((e) => {
+        expect(e).toEqual(
+          "Routing using the ArcGIS service requires authentication"
+        );
+        done();
+      });
+  });
+
+  it("should make a simple solveRoute request (array of stops)", (done) => {
+    fetchMock.once("*", Solve);
+
+    const MOCK_AUTH = {
+      getToken() {
+        return Promise.resolve("token");
+      },
+      portal: "https://mapsdev.arcgis.com",
+    };
+
+    solveRoute({ stops, authentication: MOCK_AUTH })
+      .then((response) => {
+        expect(fetchMock.called()).toEqual(true);
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual(
+          "https://route.arcgis.com/arcgis/rest/services/World/Route/NAServer/Route_World/solve"
+        );
+        expect(options.method).toBe("POST");
+        expect(options.body).toContain("f=json");
+        // "stops=-117.195677,34.056383;-117.918976,33.812092"
+        expect(options.body).toContain(
+          `stops=${encodeURIComponent(
+            "-117.195677,34.056383;-117.918976,33.812092"
+          )}`
+        );
+        expect(options.body).toContain("token=token");
+        expect(response.routes.spatialReference.latestWkid).toEqual(4326);
+        expect(response.routes.features[0].attributes.Name).toEqual(
+          "Location 1 - Location 2"
+        );
+        done();
+      })
+      .catch((e) => {
+        fail(e);
+      });
+  });
+
+  it("should make a simple solveRoute request (array of 3d stops)", (done) => {
+    fetchMock.once("*", Solve);
+
+    const MOCK_AUTH = {
+      getToken() {
+        return Promise.resolve("token");
+      },
+      portal: "https://mapsdev.arcgis.com",
+    };
+
+    solveRoute({ stops: stops3, authentication: MOCK_AUTH })
+      .then((response) => {
+        expect(fetchMock.called()).toEqual(true);
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual(
+          "https://route.arcgis.com/arcgis/rest/services/World/Route/NAServer/Route_World/solve"
+        );
+        expect(options.method).toBe("POST");
+        expect(options.body).toContain("f=json");
+        // "stops=-117.195677,34.056383,10.11;-117.918976,33.812092,8.43"
+        expect(options.body).toContain(
+          `stops=${encodeURIComponent(
+            "-117.195677,34.056383,10.11;-117.918976,33.812092,8.43"
+          )}`
+        );
+        expect(options.body).toContain("token=token");
+        expect(response.routes.spatialReference.latestWkid).toEqual(4326);
+        expect(response.routes.features[0].attributes.Name).toEqual(
+          "Location 1 - Location 2"
+        );
+        done();
+      })
+      .catch((e) => {
+        fail(e);
+      });
+  });
+
+  it("should make a simple solveRoute request (array of objects - lat/lon)", (done) => {
+    fetchMock.once("*", Solve);
+
+    const MOCK_AUTH = {
+      getToken() {
+        return Promise.resolve("token");
+      },
+      portal: "https://mapsdev.arcgis.com",
+    };
+
+    solveRoute({
+      stops: stopsObjectsLatLong,
+      authentication: MOCK_AUTH,
+    })
+      .then((response) => {
+        expect(fetchMock.called()).toEqual(true);
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual(
+          "https://route.arcgis.com/arcgis/rest/services/World/Route/NAServer/Route_World/solve"
+        );
+        expect(options.method).toBe("POST");
+        expect(options.body).toContain("f=json");
+        // "stops=-117.195677,34.056383;-117.918976,33.812092"
+        expect(options.body).toContain(
+          `stops=${encodeURIComponent(
+            "-117.195677,34.056383;-117.918976,33.812092"
+          )}`
+        );
+        expect(options.body).toContain("token=token");
+        expect(response.routes.spatialReference.latestWkid).toEqual(4326);
+        expect(response.routes.features[0].attributes.Name).toEqual(
+          "Location 1 - Location 2"
+        );
+        done();
+      })
+      .catch((e) => {
+        fail(e);
+      });
+  });
+
+  it("should make a simple solveRoute request (array of objects - 3d lat/lon)", (done) => {
+    fetchMock.once("*", Solve);
+
+    const MOCK_AUTH = {
+      getToken() {
+        return Promise.resolve("token");
+      },
+      portal: "https://mapsdev.arcgis.com",
+    };
+
+    solveRoute({
+      stops: stopsObjectsLatLong3,
+      authentication: MOCK_AUTH,
+    })
+      .then((response) => {
+        expect(fetchMock.called()).toEqual(true);
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual(
+          "https://route.arcgis.com/arcgis/rest/services/World/Route/NAServer/Route_World/solve"
+        );
+        expect(options.method).toBe("POST");
+        expect(options.body).toContain("f=json");
+        // "stops=-117.195677,34.056383,10.11;-117.918976,33.812092,8.43"
+        expect(options.body).toContain(
+          `stops=${encodeURIComponent(
+            "-117.195677,34.056383,10.11;-117.918976,33.812092,8.43"
+          )}`
+        );
+        expect(options.body).toContain("token=token");
+        expect(response.routes.spatialReference.latestWkid).toEqual(4326);
+        expect(response.routes.features[0].attributes.Name).toEqual(
+          "Location 1 - Location 2"
+        );
+        done();
+      })
+      .catch((e) => {
+        fail(e);
+      });
+  });
+
+  it("should make a simple solveRoute request (array of objects - latitude/longitude)", (done) => {
+    fetchMock.once("*", Solve);
+
+    const MOCK_AUTH = {
+      getToken() {
+        return Promise.resolve("token");
+      },
+      portal: "https://mapsdev.arcgis.com",
+    };
+
+    solveRoute({
+      stops: stopsObjectsLatitudeLongitude,
+      authentication: MOCK_AUTH,
+    })
+      .then((response) => {
+        expect(fetchMock.called()).toEqual(true);
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual(
+          "https://route.arcgis.com/arcgis/rest/services/World/Route/NAServer/Route_World/solve"
+        );
+        expect(options.method).toBe("POST");
+        expect(options.body).toContain("f=json");
+        // "stops=-117.195677,34.056383;-117.918976,33.812092"
+        expect(options.body).toContain(
+          `stops=${encodeURIComponent(
+            "-117.195677,34.056383;-117.918976,33.812092"
+          )}`
+        );
+        expect(options.body).toContain("token=token");
+        expect(response.routes.spatialReference.latestWkid).toEqual(4326);
+        expect(response.routes.features[0].attributes.Name).toEqual(
+          "Location 1 - Location 2"
+        );
+        done();
+      })
+      .catch((e) => {
+        fail(e);
+      });
+  });
+
+  it("should make a simple solveRoute request (array of objects - 3d latitude/longitude)", (done) => {
+    fetchMock.once("*", Solve);
+
+    const MOCK_AUTH = {
+      getToken() {
+        return Promise.resolve("token");
+      },
+      portal: "https://mapsdev.arcgis.com",
+    };
+
+    solveRoute({
+      stops: stopsObjectsLatitudeLongitude3,
+      authentication: MOCK_AUTH,
+    })
+      .then((response) => {
+        expect(fetchMock.called()).toEqual(true);
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual(
+          "https://route.arcgis.com/arcgis/rest/services/World/Route/NAServer/Route_World/solve"
+        );
+        expect(options.method).toBe("POST");
+        expect(options.body).toContain("f=json");
+        // "stops=-117.195677,34.056383,10.11;-117.918976,33.812092,8.43"
+        expect(options.body).toContain(
+          `stops=${encodeURIComponent(
+            "-117.195677,34.056383,10.11;-117.918976,33.812092,8.43"
+          )}`
+        );
+        expect(options.body).toContain("token=token");
+        expect(response.routes.spatialReference.latestWkid).toEqual(4326);
+        expect(response.routes.features[0].attributes.Name).toEqual(
+          "Location 1 - Location 2"
+        );
+        done();
+      })
+      .catch((e) => {
+        fail(e);
+      });
+  });
+
+  it("should make a simple solveRoute request (array of objects - latitude/longitude)", (done) => {
+    fetchMock.once("*", Solve);
+
+    const MOCK_AUTH = {
+      getToken() {
+        return Promise.resolve("token");
+      },
+      portal: "https://mapsdev.arcgis.com",
+    };
+
+    solveRoute({
+      stops: stopsObjectsLatitudeLongitude,
+      authentication: MOCK_AUTH,
+    })
+      .then((response) => {
+        expect(fetchMock.called()).toEqual(true);
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual(
+          "https://route.arcgis.com/arcgis/rest/services/World/Route/NAServer/Route_World/solve"
+        );
+        expect(options.method).toBe("POST");
+        expect(options.body).toContain("f=json");
+        // "stops=-117.195677,34.056383;-117.918976,33.812092"
+        expect(options.body).toContain(
+          `stops=${encodeURIComponent(
+            "-117.195677,34.056383;-117.918976,33.812092"
+          )}`
+        );
+        expect(options.body).toContain("token=token");
+        expect(response.routes.spatialReference.latestWkid).toEqual(4326);
+        expect(response.routes.features[0].attributes.Name).toEqual(
+          "Location 1 - Location 2"
+        );
+        done();
+      })
+      .catch((e) => {
+        fail(e);
+      });
+  });
+
+  it("should make a simple solveRoute request (array of objects - 3d latitude/longitude)", (done) => {
+    fetchMock.once("*", Solve);
+
+    const MOCK_AUTH = {
+      getToken() {
+        return Promise.resolve("token");
+      },
+      portal: "https://mapsdev.arcgis.com",
+    };
+
+    solveRoute({
+      stops: stopsObjectsLatitudeLongitude3,
+      authentication: MOCK_AUTH,
+    })
+      .then((response) => {
+        expect(fetchMock.called()).toEqual(true);
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual(
+          "https://route.arcgis.com/arcgis/rest/services/World/Route/NAServer/Route_World/solve"
+        );
+        expect(options.method).toBe("POST");
+        expect(options.body).toContain("f=json");
+        // "stops=-117.195677,34.056383,10.11;-117.918976,33.812092,8.43"
+        expect(options.body).toContain(
+          `stops=${encodeURIComponent(
+            "-117.195677,34.056383,10.11;-117.918976,33.812092,8.43"
+          )}`
+        );
+        expect(options.body).toContain("token=token");
+        expect(response.routes.spatialReference.latestWkid).toEqual(4326);
+        expect(response.routes.features[0].attributes.Name).toEqual(
+          "Location 1 - Location 2"
+        );
+        done();
+      })
+      .catch((e) => {
+        fail(e);
+      });
+  });
+
+  it("should make a simple solveRoute request (array of IPoint)", (done) => {
+    fetchMock.once("*", Solve);
+
+    const MOCK_AUTH = {
+      getToken() {
+        return Promise.resolve("token");
+      },
+      portal: "https://mapsdev.arcgis.com",
+    };
+
+    solveRoute({
+      stops: stopsObjectsPoint,
+      authentication: MOCK_AUTH,
+    })
+      .then((response) => {
+        expect(fetchMock.called()).toEqual(true);
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual(
+          "https://route.arcgis.com/arcgis/rest/services/World/Route/NAServer/Route_World/solve"
+        );
+        expect(options.method).toBe("POST");
+        expect(options.body).toContain("f=json");
+        // "stops=-117.195677,34.056383;-117.918976,33.812092"
+        expect(options.body).toContain(
+          `stops=${encodeURIComponent(
+            "-117.195677,34.056383;-117.918976,33.812092"
+          )}`
+        );
+        expect(options.body).toContain("token=token");
+        expect(response.routes.spatialReference.latestWkid).toEqual(4326);
+        expect(response.routes.features[0].attributes.Name).toEqual(
+          "Location 1 - Location 2"
+        );
+        done();
+      })
+      .catch((e) => {
+        fail(e);
+      });
+  });
+
+  it("should make a simple solveRoute request (array of 3d IPoint)", (done) => {
+    fetchMock.once("*", Solve);
+
+    const MOCK_AUTH = {
+      getToken() {
+        return Promise.resolve("token");
+      },
+      portal: "https://mapsdev.arcgis.com",
+    };
+
+    solveRoute({
+      stops: stopsObjectsPoint3,
+      authentication: MOCK_AUTH,
+    })
+      .then((response) => {
+        expect(fetchMock.called()).toEqual(true);
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual(
+          "https://route.arcgis.com/arcgis/rest/services/World/Route/NAServer/Route_World/solve"
+        );
+        expect(options.method).toBe("POST");
+        expect(options.body).toContain("f=json");
+        // "stops=-117.195677,34.056383,10.11;-117.918976,33.812092,8.43"
+        expect(options.body).toContain(
+          `stops=${encodeURIComponent(
+            "-117.195677,34.056383,10.11;-117.918976,33.812092,8.43"
+          )}`
+        );
+        expect(options.body).toContain("token=token");
+        expect(response.routes.spatialReference.latestWkid).toEqual(4326);
+        expect(response.routes.features[0].attributes.Name).toEqual(
+          "Location 1 - Location 2"
+        );
+        done();
+      })
+      .catch((e) => {
+        fail(e);
+      });
+  });
+
+  it("should make a simple solveRoute request (FeatureSet)", (done) => {
+    fetchMock.once("*", Solve);
+
+    const MOCK_AUTH = {
+      getToken() {
+        return Promise.resolve("token");
+      },
+      portal: "https://mapsdev.arcgis.com",
+    };
+
+    solveRoute({
+      stops: stopsFeatureSet,
+      authentication: MOCK_AUTH,
+    })
+      .then((response) => {
+        expect(fetchMock.called()).toEqual(true);
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual(
+          "https://route.arcgis.com/arcgis/rest/services/World/Route/NAServer/Route_World/solve"
+        );
+        expect(options.method).toBe("POST");
+        expect(options.body).toContain("f=json");
+        expect(options.body).toContain(
+          `stops=${encodeURIComponent(JSON.stringify(stopsFeatureSet))}`
+        );
+        expect(options.body).toContain("token=token");
+        expect(response.routes.spatialReference.latestWkid).toEqual(4326);
+        expect(response.routes.features[0].attributes.Name).toEqual(
+          "Location 1 - Location 2"
+        );
+        done();
+      })
+      .catch((e) => {
+        fail(e);
+      });
+  });
+
+  it("should transform compressed geometry into geometry", (done) => {
+    fetchMock.once("*", Solve);
+
+    const MOCK_AUTH = {
+      getToken() {
+        return Promise.resolve("token");
+      },
+      portal: "https://mapsdev.arcgis.com",
+    };
+
+    solveRoute({
+      stops: stopsObjectsPoint,
+      authentication: MOCK_AUTH,
+    })
+      .then((response) => {
+        expect(fetchMock.called()).toEqual(true);
+        expect(response.directions[0].features[0].geometry).toEqual(
+          jasmine.any(Object)
+        );
+        done();
+      })
+      .catch((e) => {
+        fail(e);
+      });
+  });
+
+  it("should not fail when no directions are returned", (done) => {
+    fetchMock.once("*", SolveNoDirections);
+
+    const MOCK_AUTH = {
+      getToken() {
+        return Promise.resolve("token");
+      },
+      portal: "https://mapsdev.arcgis.com",
+    };
+
+    solveRoute({
+      stops: stopsObjectsPoint,
+      authentication: MOCK_AUTH,
+      params: {
+        returnDirections: false,
+      },
+    })
+      .then((response) => {
+        expect(fetchMock.called()).toEqual(true);
+        expect(response.directions).toEqual(undefined);
+        done();
+      })
+      .catch((e) => {
+        fail(e);
+      });
+  });
+
+  it("should include routes.geoJson in the return", (done) => {
+    fetchMock.once("*", Solve);
+
+    const MOCK_AUTH = {
+      getToken() {
+        return Promise.resolve("token");
+      },
+      portal: "https://mapsdev.arcgis.com",
+    };
+
+    solveRoute({
+      stops: stopsObjectsPoint,
+      authentication: MOCK_AUTH,
+    })
+      .then((response) => {
+        expect(fetchMock.called()).toEqual(true);
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(Object.keys(response.routes)).toContain("geoJson");
+        done();
+      })
+      .catch((e) => {
+        fail(e);
+      });
+  });
+
+  it("should not include routes.geoJson in the return for non-4326", (done) => {
+    fetchMock.once("*", SolveWebMercator);
+
+    const MOCK_AUTH = {
+      getToken() {
+        return Promise.resolve("token");
+      },
+      portal: "https://mapsdev.arcgis.com",
+    };
+
+    solveRoute({
+      stops: stopsObjectsPoint,
+      authentication: MOCK_AUTH,
+      params: {
+        outSR: 102100,
+      },
+    })
+      .then((response) => {
+        expect(fetchMock.called()).toEqual(true);
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(Object.keys(response.routes)).not.toContain("geoJson");
+        done();
+      })
+      .catch((e) => {
+        fail(e);
+      });
+  });
+});

package/packages/arcgis-rest-routing/tsconfig.json

@@ -0,0 +1,6 @@
+{
+  "extends": "../../tsconfig.json",
+  "include": [
+      "src/**/*.ts"
+  ]
+}