sintfacilis 1.0.0

package/packages/arcgis-rest-request/test/utils/process-params.test.ts

@@ -0,0 +1,205 @@
+/* Copyright (c) 2018-2019 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { processParams, requiresFormData } from "../../src/index";
+
+describe("processParams", () => {
+  it("should pass non Date, Function, Array and Object params through", () => {
+    const params = {
+      foo: "foo",
+      bar: 1
+    };
+
+    const expected = {
+      foo: "foo",
+      bar: 1
+    };
+    expect(processParams(params)).toEqual(expected);
+  });
+
+  it("should encode Dates as timestamps", () => {
+    const date = new Date();
+
+    const params = {
+      foo: date
+    };
+
+    const expected = {
+      foo: date.getTime()
+    };
+    expect(processParams(params)).toEqual(expected);
+  });
+
+  it("should not encode a function", () => {
+    const params = {
+      foo() {} // tslint:disable-line no-empty
+    };
+
+    expect(processParams(params)).toEqual({});
+  });
+
+  it("should stringify objects", () => {
+    const params = {
+      foo: {
+        bar: "bar"
+      }
+    };
+
+    const expected = {
+      foo: '{"bar":"bar"}'
+    };
+
+    expect(processParams(params)).toEqual(expected);
+  });
+
+  it("should stringify arrays of objects", () => {
+    const params = {
+      foo: [
+        {
+          bar: "bar"
+        }
+      ]
+    };
+
+    const expected = {
+      foo: '[{"bar":"bar"}]'
+    };
+
+    expect(processParams(params)).toEqual(expected);
+  });
+
+  it("should comma separate arrays of non objects", () => {
+    const params = {
+      foo: ["bar", "baz"]
+    };
+
+    const expected = {
+      foo: "bar,baz"
+    };
+
+    expect(processParams(params)).toEqual(expected);
+  });
+
+  it("should pass array of arrays through", () => {
+    const params = {
+      foo: [["bar1"], ["baz1", "baz2"]]
+    };
+
+    const expected = {
+      foo: [["bar1"], ["baz1", "baz2"]]
+    };
+
+    expect(processParams(params)).toEqual(expected);
+  });
+
+  it("should stringify booleans", () => {
+    const params = {
+      foo: true,
+      bar: false
+    };
+
+    const expected = {
+      foo: "true",
+      bar: "false"
+    };
+
+    expect(processParams(params)).toEqual(expected);
+  });
+
+  it("should exclude null and undefined, but not a zero", () => {
+    const params: any = {
+      foo: null,
+      bar: undefined,
+      baz: 0
+    };
+
+    const expected = {
+      baz: 0
+    };
+
+    expect(processParams(params)).toEqual(expected);
+  });
+
+  it("should not require form data for simple requests", () => {
+    expect(
+      requiresFormData({
+        string: "string"
+      })
+    ).toBeFalsy();
+
+    expect(
+      requiresFormData({
+        number: 123
+      })
+    ).toBeFalsy();
+
+    expect(
+      requiresFormData({
+        date: new Date()
+      })
+    ).toBeFalsy();
+
+    expect(
+      requiresFormData({
+        boolean: true
+      })
+    ).toBeFalsy();
+
+    expect(
+      requiresFormData({
+        array: []
+      })
+    ).toBeFalsy();
+
+    expect(
+      requiresFormData({
+        object: {}
+      })
+    ).toBeFalsy();
+
+    expect(
+      requiresFormData({
+        fn: () => {
+          return;
+        }
+      })
+    ).toBeFalsy();
+
+    expect(
+      requiresFormData({
+        falsy: null
+      })
+    ).toBeFalsy();
+  });
+
+  it("should require form data for multipart requests", () => {
+    const binaryObj =
+      typeof File !== "undefined"
+        ? new File(["foo"], "foo.txt", {
+            type: "text/plain"
+          })
+        : Buffer.from("");
+
+    expect(
+      requiresFormData({
+        binary: binaryObj
+      })
+    ).toBeTruthy();
+  });
+
+  it("should require form data for mixed multipart requests", () => {
+    const binaryObj =
+      typeof File !== "undefined"
+        ? new File(["foo"], "foo.txt", {
+            type: "text/plain"
+          })
+        : Buffer.from("");
+
+    expect(
+      requiresFormData({
+        string: "string",
+        binary: binaryObj
+      })
+    ).toBeTruthy();
+  });
+});

package/packages/arcgis-rest-request/test/utils/with-options.test.ts

@@ -0,0 +1,133 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { request } from "../../src/request";
+import { IRequestOptions } from "../../src/utils/IRequestOptions";
+import { withOptions } from "../../src/utils/with-options";
+
+import * as fetchMock from "fetch-mock";
+
+const SharingRestInfo = {
+  owningSystemUrl: "http://www.arcgis.com",
+  authInfo: {
+    tokenServicesUrl: "https://www.arcgis.com/sharing/rest/generateToken",
+    isTokenBasedSecurity: true
+  }
+};
+
+describe("withOptions()", () => {
+  afterEach(fetchMock.restore);
+
+  it("should wrap a basic request with default options", done => {
+    fetchMock.once("*", SharingRestInfo);
+    const requestWithOptions = withOptions(
+      {
+        headers: {
+          "Test-Header": "Test"
+        }
+      },
+      request
+    );
+
+    requestWithOptions("https://www.arcgis.com/sharing/rest/info")
+      .then(() => {
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual("https://www.arcgis.com/sharing/rest/info");
+        expect((options.headers as any)["Test-Header"]).toBe("Test");
+        done();
+      })
+      .catch((e: any) => {
+        fail(e);
+      });
+  });
+
+  it("should wrap a custom request implementation with default options", done => {
+    const MockResponse = {
+      test: "bar"
+    };
+
+    fetchMock.once("*", MockResponse);
+
+    interface ICustomOptions extends IRequestOptions {
+      id: string;
+    }
+
+    interface ICustomResponse {
+      test: string;
+    }
+
+    function customRequest(options: ICustomOptions): Promise<ICustomResponse> {
+      options.params = {
+        id: options.id
+      };
+      return request("https://www.arcgis.com/sharing/rest/info", options);
+    }
+
+    const requestWithOptions = withOptions(
+      {
+        headers: {
+          "Test-Header": "Test"
+        }
+      },
+      customRequest
+    );
+
+    requestWithOptions({
+      id: "foo"
+    })
+      .then(() => {
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual("https://www.arcgis.com/sharing/rest/info");
+        expect(options.body).toContain("id=foo");
+        expect((options.headers as any)["Test-Header"]).toBe("Test");
+        done();
+      })
+      .catch((e: any) => {
+        fail(e);
+      });
+  });
+
+  it("should wrap a custom request implementation with multiple parameters with a default URL", done => {
+    const MockResponse = {
+      test: "bar"
+    };
+
+    fetchMock.once("*", MockResponse);
+
+    interface ICustomResponse {
+      test: string;
+    }
+
+    function customRequest(
+      id: string,
+      options: IRequestOptions = {}
+    ): Promise<ICustomResponse> {
+      options = {
+        ...options,
+        ...{ params: { ...options.params, ...{ id } } }
+      };
+      return request("https://www.arcgis.com/sharing/rest/info", options);
+    }
+
+    const requestWithOptions = withOptions(
+      {
+        headers: {
+          "Test-Header": "Test"
+        }
+      },
+      customRequest
+    );
+
+    requestWithOptions("foo")
+      .then(() => {
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual("https://www.arcgis.com/sharing/rest/info");
+        expect(options.body).toContain("id=foo");
+        expect((options.headers as any)["Test-Header"]).toBe("Test");
+        done();
+      })
+      .catch((e: any) => {
+        fail(e);
+      });
+  });
+});

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

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

package/packages/arcgis-rest-routing/README.md

@@ -0,0 +1,75 @@
+[![npm version][npm-img]][npm-url]
+[![build status][travis-img]][travis-url]
+[![gzip bundle size][gzip-image]][npm-url]
+[![Coverage Status][coverage-img]][coverage-url]
+[![apache licensed](https://img.shields.io/badge/license-Apache-green.svg?style=flat-square)](https://raw.githubusercontent.com/Esri/arcgis-rest-js/master/LICENSE)
+
+[npm-img]: https://img.shields.io/npm/v/@esri/arcgis-rest-routing.svg?style=flat-square
+[npm-url]: https://www.npmjs.com/package/@esri/arcgis-rest-routing
+[travis-img]: https://img.shields.io/travis/Esri/arcgis-rest-js/master.svg?style=flat-square
+[travis-url]: https://travis-ci.org/Esri/arcgis-rest-js
+[gzip-image]: https://img.badgesize.io/https://unpkg.com/@esri/arcgis-rest-routing/dist/umd/routing.umd.min.js?compression=gzip
+[coverage-img]: https://codecov.io/gh/Esri/arcgis-rest-js/branch/master/graph/badge.svg
+[coverage-url]: https://codecov.io/gh/Esri/arcgis-rest-js
+
+# @esri/arcgis-rest-routing
+
+> Routing helpers for [`@esri/arcgis-rest-request`](https://github.com/Esri/arcgis-rest-js).
+
+### Example
+
+```bash
+npm install @esri/arcgis-rest-request
+npm install @esri/arcgis-rest-common
+npm install @esri/arcgis-rest-routing
+```
+
+```js
+solveRoute({
+  stops: [
+    [-117.195677, 34.056383],
+    [-117.918976, 33.812092],
+  ],
+  authentication
+})
+.then(response)
+// {routes: {features: [{attributes: { ... }, geometry:{ ... }}]}}
+```
+
+### [API Reference](https://esri.github.io/arcgis-rest-js/api/routing/)
+
+### Issues
+
+If something isn't working the way you expected, please take a look at [previously logged issues](https://github.com/Esri/arcgis-rest-js/issues) first.  Have you found a new bug?  Want to request a new feature?  We'd [**love**](https://github.com/Esri/arcgis-rest-js/issues/new) to hear from you.
+
+If you're looking for help you can also post issues on [GIS Stackexchange](http://gis.stackexchange.com/questions/ask?tags=esri-oss).
+
+### Versioning
+
+For transparency into the release cycle and in striving to maintain backward compatibility, @esri/arcgis-rest-js is maintained under Semantic Versioning guidelines and will adhere to these rules whenever possible.
+
+For more information on SemVer, please visit <http://semver.org/>.
+
+### Contributing
+
+Esri welcomes contributions from anyone and everyone. Please see our [guidelines for contributing](CONTRIBUTING.md).
+
+### [Changelog](https://github.com/Esri/arcgis-rest-js/blob/master/CHANGELOG.md)
+
+### License
+
+Copyright &copy; 2018 Esri
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+> http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+A copy of the license is available in the repository's [LICENSE](../../LICENSE) file.

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

@@ -0,0 +1,65 @@
+{
+  "name": "@esri/arcgis-rest-routing",
+  "version": "3.3.0",
+  "description": "Routing helpers for @esri/arcgis-rest-js",
+  "main": "dist/node/index.js",
+  "unpkg": "dist/umd/routing.umd.js",
+  "module": "dist/esm/index.js",
+  "js:next": "dist/esm/index.js",
+  "sideEffects": false,
+  "types": "dist/esm/index.d.ts",
+  "license": "Apache-2.0",
+  "files": [
+    "dist/**"
+  ],
+  "dependencies": {
+    "@esri/arcgis-rest-types": "^3.3.0",
+    "@terraformer/arcgis": "^2.0.7",
+    "@types/terraformer__arcgis": "^2.0.0",
+    "tslib": "^1.13.0"
+  },
+  "devDependencies": {
+    "@esri/arcgis-rest-auth": "^3.3.0",
+    "@esri/arcgis-rest-request": "^3.3.0"
+  },
+  "peerDependencies": {
+    "@esri/arcgis-rest-auth": "^3.0.0",
+    "@esri/arcgis-rest-request": "^3.0.0"
+  },
+  "scripts": {
+    "prepare": "npm run build",
+    "build": "npm run build:node && npm run build:umd && npm run build:esm",
+    "build:esm": "tsc --module es2015 --outDir ./dist/esm --declaration",
+    "build:umd": "rollup -c ../../umd-base-profile.js && rollup -c ../../umd-production-profile.js",
+    "build:node": "tsc --module commonjs --outDir ./dist/node",
+    "dev:esm": "tsc -w --module es2015 --outDir ./dist/esm --declaration",
+    "dev:umd": "rollup -w -c ../../umd-base-profile.js",
+    "dev:node": "tsc -w --module commonjs --outDir ./dist/node"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Esri/arcgis-rest-js.git",
+    "directory": "packages/arcgis-rest-routing"
+  },
+  "contributors": [
+    {
+      "name": "Gavin Rehkemper",
+      "email": "gavin@gavinr.com"
+    }
+  ],
+  "bugs": {
+    "url": "https://github.com/Esri/arcgis-rest-js/issues"
+  },
+  "homepage": "https://github.com/Esri/arcgis-rest-js#readme",
+  "keywords": [
+    "typescript",
+    "promise",
+    "fetch",
+    "arcgis",
+    "esri",
+    "ES6"
+  ]
+}

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

@@ -0,0 +1,225 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import {
+  request,
+  cleanUrl,
+  appendCustomParams,
+} from "@esri/arcgis-rest-request";
+
+import {
+  ILocation,
+  IPoint,
+  IFeature,
+  IFeatureSet,
+} from "@esri/arcgis-rest-types";
+
+import {
+  ARCGIS_ONLINE_CLOSEST_FACILITY_URL,
+  IEndpointOptions,
+  normalizeLocationsList,
+  isFeatureSet,
+} from "./helpers";
+
+import { arcgisToGeoJSON } from "@terraformer/arcgis";
+
+export interface IClosestFacilityOptions extends IEndpointOptions {
+  /**
+   * Specify one or more locations from which the service searches for the nearby locations. These locations are referred to as incidents.
+   */
+  incidents: Array<IPoint | ILocation | [number, number]> | IFeatureSet;
+
+  /**
+   * Specify one or more locations that are searched for when finding the closest location.
+   */
+  facilities: Array<IPoint | ILocation | [number, number]> | IFeatureSet;
+  /**
+   *  Specify if the service should return routes.
+   */
+  returnCFRoutes: boolean;
+  travelDirection?: "incidentsToFacilities" | "facilitiesToIncidents";
+  barriers?: Array<IPoint | ILocation | [number, number]> | IFeatureSet;
+  polylineBarriers?: IFeatureSet;
+  polygonBarriers?: IFeatureSet;
+  returnDirections?: boolean;
+  directionsOutputType?:
+    | "esriDOTComplete"
+    | "esriDOTCompleteNoEvents"
+    | "esriDOTInstructionsOnly"
+    | "esriDOTStandard"
+    | "esriDOTSummaryOnly"
+    | "esriDOTFeatureSets";
+  directionsLengthUnits?:
+    | "esriNAUCentimeters"
+    | "esriNAUDecimalDegrees"
+    | "esriNAUDecimeters"
+    | "esriNAUFeet"
+    | "esriNAUInches"
+    | "esriNAUKilometers"
+    | "esriNAUMeters"
+    | "esriNAUMiles"
+    | "esriNAUMillimeters"
+    | "esriNAUNauticalMiles"
+    | "esriNAUPoints"
+    | "esriNAUYards";
+  outputLines?: boolean;
+  returnFacilities?: boolean;
+  returnIncidents?: boolean;
+  returnBarriers?: boolean;
+  returnPolylineBarriers?: boolean;
+  returnPolygonBarriers?: boolean;
+  preserveObjectID?: boolean;
+}
+
+interface IFeatureSetWithGeoJson extends IFeatureSet {
+  geoJson?: any;
+}
+
+export interface IClosestFacilityResponse {
+  messages: string[];
+  routes?: IFeatureSetWithGeoJson;
+  directions?: Array<{
+    routeId: number;
+    routeName: string;
+    summary: object;
+    features: IFeature[];
+  }>;
+  incidents?: IFeatureSet;
+  facilities?: IFeatureSet;
+  barriers?: IFeatureSet;
+  polygonBarriers?: IFeatureSet;
+  polylineBarriers?: IFeatureSet;
+}
+
+function getTravelDirection(
+  key: "incidentsToFacilities" | "facilitiesToIncidents"
+): "esriNATravelDirectionFromFacility" | "esriNATravelDirectionToFacility" {
+  if (key === "incidentsToFacilities") {
+    return "esriNATravelDirectionFromFacility";
+  } else {
+    return "esriNATravelDirectionToFacility";
+  }
+}
+
+/**
+ * ```js
+ * import { closestFacility } from '@esri/arcgis-rest-routing';
+ * //
+ * closestFacility({
+ *   incidents: [
+ *     [-90.404302, 38.600621],
+ *     [-90.364293, 38.620427],
+ *    ],
+ *   facilities: [
+ *     [-90.444716, 38.635501],
+ *     [-90.311919, 38.633523],
+ *     [-90.451147, 38.581107]
+ *    ],
+ *    authentication
+ * })
+ *   .then(response) // => {routes: {features: [{attributes: { ... }, geometry:{ ... }}]}
+ * ```
+ * Used to find a route to the nearest of several possible destinations. See the [REST Documentation](https://developers.arcgis.com/rest/network/api-reference/closest-facility-synchronous-service.htm) for more information.
+ *
+ * @param requestOptions Options to pass through to the routing service.
+ * @returns A Promise that will resolve with routes and directions for the request.
+ * @restlink https://developers.arcgis.com/rest/network/api-reference/closest-facility-synchronous-service.htm
+ */
+export function closestFacility(
+  requestOptions: IClosestFacilityOptions
+): Promise<IClosestFacilityResponse> {
+  const endpoint =
+    requestOptions.endpoint || ARCGIS_ONLINE_CLOSEST_FACILITY_URL;
+
+  requestOptions.params = {
+    returnFacilities: true,
+    returnDirections: true,
+    returnIncidents: true,
+    returnBarriers: true,
+    returnPolylineBarriers: true,
+    returnPolygonBarriers: true,
+    preserveObjectID: true,
+    ...requestOptions.params,
+  };
+
+  const options = appendCustomParams<IClosestFacilityOptions>(requestOptions, [
+    "returnCFRoutes",
+    // "travelDirection",
+    "barriers",
+    "polylineBarriers",
+    "polygonBarriers",
+    "returnDirections",
+    "directionsOutputType",
+    "directionsLengthUnits",
+    "outputLines",
+    "returnFacilities",
+    "returnIncidents",
+    "returnBarriers",
+    "returnPolylineBarriers",
+    "returnPolygonBarriers",
+    "preserveObjectID",
+  ]);
+
+  // Set travelDirection
+  if (requestOptions.travelDirection) {
+    options.params.travelDirection = getTravelDirection(
+      requestOptions.travelDirection
+    );
+  }
+
+  // the SAAS service does not support anonymous requests
+  if (
+    !requestOptions.authentication &&
+    endpoint === ARCGIS_ONLINE_CLOSEST_FACILITY_URL
+  ) {
+    return Promise.reject(
+      "Finding the closest facility using the ArcGIS service requires authentication"
+    );
+  }
+
+  if (isFeatureSet(requestOptions.incidents)) {
+    options.params.incidents = requestOptions.incidents;
+  } else {
+    options.params.incidents = normalizeLocationsList(
+      requestOptions.incidents
+    ).join(";");
+  }
+
+  if (isFeatureSet(requestOptions.facilities)) {
+    options.params.facilities = requestOptions.facilities;
+  } else {
+    options.params.facilities = normalizeLocationsList(
+      requestOptions.facilities
+    ).join(";");
+  }
+
+  // optional input param that may need point geometry normalizing
+  if (requestOptions.barriers) {
+    if (isFeatureSet(requestOptions.barriers)) {
+      options.params.barriers = requestOptions.barriers;
+    } else {
+      // optional point geometry barriers must be normalized, too
+      // but not if provided as IFeatureSet type
+      // note that optional polylineBarriers and polygonBarriers do not need to be normalized
+      options.params.barriers = normalizeLocationsList(
+        requestOptions.barriers
+      ).join(";");
+    }
+  }
+
+  return request(`${cleanUrl(endpoint)}/solveClosestFacility`, options).then(
+    cleanResponse
+  );
+}
+
+function cleanResponse(res: any): IClosestFacilityResponse {
+  // add "geoJson" property to "routes"
+  if (res.routes.spatialReference.wkid === 4326) {
+    res.routes.geoJson = arcgisToGeoJSON(res.routes);
+  }
+  return res;
+}
+
+export default {
+  closestFacility,
+};