ducimusipsa 1.0.0

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

@@ -0,0 +1,267 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { solveRoute } from "../src/solveRoute";
+
+import * as fetchMock from "fetch-mock";
+
+import { Solve } from "./mocks/responses";
+import { IPoint, ILocation } from "@esri/arcgis-rest-common";
+
+// -117.195677,34.056383;-117.918976,33.812092
+const stops: Array<[number, number]> = [
+  [-117.195677, 34.056383],
+  [-117.918976, 33.812092]
+];
+
+const stopsObjectsLatLong: ILocation[] = [
+  {
+    lat: 34.056383,
+    long: -117.195677
+  },
+  {
+    lat: 33.812092,
+    long: -117.918976
+  }
+];
+
+const stopsObjectsLatitudeLongitude: ILocation[] = [
+  {
+    latitude: 34.056383,
+    longitude: -117.195677
+  },
+  {
+    latitude: 33.812092,
+    longitude: -117.918976
+  }
+];
+
+const stopsObjectsPoint: IPoint[] = [
+  {
+    x: 34.056383,
+    y: -117.195677
+  },
+  {
+    x: 33.812092,
+    y: -117.918976
+  }
+];
+
+// 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 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 - 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 - 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 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);
+      });
+  });
+});

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

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

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

@@ -0,0 +1,70 @@
+[![npm version][npm-img]][npm-url]
+[![build status][travis-img]][travis-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-sharing.svg?style=flat-square
+[npm-url]: https://www.npmjs.com/package/@esri/arcgis-rest-sharing
+[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
+[coverage-img]: https://coveralls.io/repos/github/Esri/arcgis-rest-js/badge.svg
+[coverage-url]: https://coveralls.io/github/Esri/arcgis-rest-js
+
+# @esri/arcgis-rest-sharing
+
+> Helper utilities for managing access to ArcGIS content in Node.js and modern browsers.
+
+### Example
+
+```bash
+npm install @esri/arcgis-rest-request
+npm install @esri/arcgis-rest-sharing
+```
+
+```js
+import { setItemAccess } from '@esri/arcgis-rest-sharing';
+
+const itemId = "abc123";
+
+setItemAccess({
+    id: itemId,
+    access: "public",
+    authentication: session
+})
+```
+
+### [API Reference](https://esri.github.io/arcgis-rest-js/api/sharing/)
+
+### 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).
+
+### 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-sharing/package-lock.json

@@ -0,0 +1,11 @@
+{
+	"requires": true,
+	"lockfileVersion": 1,
+	"dependencies": {
+		"tslib": {
+			"version": "1.9.1",
+			"resolved": "https://registry.npmjs.org/tslib/-/tslib-1.9.1.tgz",
+			"integrity": "sha512-avfPS28HmGLLc2o4elcc2EIq2FcH++Yo5YxpBZi9Yw93BCTGFthI4HPE4Rpep6vSYQaK8e69PelM44tPj+RaQg=="
+		}
+	}
+}

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

@@ -0,0 +1,60 @@
+{
+  "name": "@esri/arcgis-rest-sharing",
+  "version": "1.14.1",
+  "description": "Helper utilities for managing access to ArcGIS content in Node.js and modern browsers.",
+  "main": "dist/node/index.js",
+  "browser": "dist/umd/sharing.umd.js",
+  "module": "dist/esm/index.js",
+  "js:next": "dist/esm/index.js",
+  "types": "dist/esm/index.d.ts",
+  "license": "Apache-2.0",
+  "dependencies": {
+    "tslib": "^1.8.0"
+  },
+  "devDependencies": {
+    "@esri/arcgis-rest-auth": "^1.14.1",
+    "@esri/arcgis-rest-common-types": "^1.14.1",
+    "@esri/arcgis-rest-groups": "^1.14.1",
+    "@esri/arcgis-rest-request": "^1.14.1"
+  },
+  "peerDependencies": {
+    "@esri/arcgis-rest-auth": "^1.14.1",
+    "@esri/arcgis-rest-common-types": "^1.14.1",
+    "@esri/arcgis-rest-groups": "^1.14.1",
+    "@esri/arcgis-rest-request": "^1.14.1"
+  },
+  "files": [
+    "dist/**"
+  ],
+  "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"
+  },
+  "contributors": [
+    {
+      "name": "John Gravois",
+      "email": "john@esri.com"
+    },
+    {
+      "name": "Tom Wayson",
+      "email": "tom@tomwayson.com"
+    }
+  ],
+  "bugs": {
+    "url": "https://github.com/Esri/arcgis-rest-js/issues"
+  },
+  "homepage": "https://github.com/Esri/arcgis-rest-js#readme"
+}

package/packages/arcgis-rest-sharing/src/access.ts

@@ -0,0 +1,85 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { request } from "@esri/arcgis-rest-request";
+
+import {
+  ISharingRequestOptions,
+  ISharingResponse,
+  isItemOwner,
+  getSharingUrl,
+  isOrgAdmin
+} from "./helpers";
+
+export interface ISetAccessRequestOptions extends ISharingRequestOptions {
+  /**
+   * "private" indicates that the item can only be accessed by the user. "public" means accessible to anyone. An item shared to the organization has an access level of "org".
+   */
+  access: "private" | "org" | "public";
+}
+
+/**
+ * Set access level of an item to 'public', 'org', or 'private'.
+ *
+ * ```js
+ * import { setItemAccess } from '@esri/arcgis-rest-sharing';
+ *
+ * setItemAccess({
+ *   id: "abc123",
+ *   access: "public",
+ *   authentication: session
+ * })
+ * ```
+ *
+ * @param requestOptions - Options for the request.
+ * @returns A Promise that will resolve with the data from the response.
+ */
+export function setItemAccess(
+  requestOptions: ISetAccessRequestOptions
+): Promise<ISharingResponse> {
+  const url = getSharingUrl(requestOptions);
+
+  if (isItemOwner(requestOptions)) {
+    // if the user owns the item, proceed
+    return updateItemAccess(url, requestOptions);
+  } else {
+    // otherwise we need to check to see if they are an organization admin
+    return isOrgAdmin(requestOptions).then(admin => {
+      if (admin) {
+        return updateItemAccess(url, requestOptions);
+      } else {
+        // if neither, updating the sharing isnt possible
+        throw Error(
+          `This item can not be shared by ${
+            requestOptions.authentication.username
+          }. They are neither the item owner nor an organization admin.`
+        );
+      }
+    });
+  }
+}
+
+function updateItemAccess(
+  url: string,
+  requestOptions: ISetAccessRequestOptions
+): Promise<any> {
+  requestOptions.params = {
+    org: false,
+    everyone: false,
+    ...requestOptions.params
+  };
+
+  // if the user wants to make the item private, it needs to be unshared from any/all groups as well
+  if (requestOptions.access === "private") {
+    requestOptions.params.groups = " ";
+  }
+  if (requestOptions.access === "org") {
+    requestOptions.params.org = true;
+  }
+  // if sharing with everyone, share with the entire organization as well.
+  if (requestOptions.access === "public") {
+    requestOptions.params.org = true;
+    requestOptions.params.everyone = true;
+  }
+  return request(url, requestOptions);
+}