sintfacilis 1.0.0

package/packages/arcgis-rest-geocoding/test/reverse.test.ts

@@ -0,0 +1,126 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { reverseGeocode } from "../src/reverse";
+
+import * as fetchMock from "fetch-mock";
+
+import { ReverseGeocode } from "./mocks/responses";
+
+describe("geocode", () => {
+  afterEach(fetchMock.restore);
+
+  it("should make a reverse geocoding request", done => {
+    fetchMock.once("*", ReverseGeocode);
+
+    reverseGeocode({ x: -118.409, y: 33.9425 })
+      .then(response => {
+        expect(fetchMock.called()).toEqual(true);
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual(
+          "https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer/reverseGeocode"
+        );
+        expect(options.method).toBe("POST");
+        expect(options.body).toContain("f=json");
+        expect(options.body).toContain(
+          `location=${encodeURIComponent('{"x":-118.409,"y":33.9425}')}`
+        );
+        expect(response).toEqual(ReverseGeocode); // introspect the entire response
+        done();
+      })
+      .catch(e => {
+        fail(e);
+      });
+  });
+
+  it("should make a reverse geocoding GET request and pass through a spatial reference", done => {
+    fetchMock.once("*", ReverseGeocode);
+
+    reverseGeocode(
+      { x: -118.409, y: 33.9425, spatialReference: { wkid: 4326 } },
+      { httpMethod: "GET" }
+    )
+      .then(response => {
+        expect(fetchMock.called()).toEqual(true);
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual(
+          "https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer/reverseGeocode?f=json&location=%7B%22x%22%3A-118.409%2C%22y%22%3A33.9425%2C%22spatialReference%22%3A%7B%22wkid%22%3A4326%7D%7D"
+        );
+        expect(options.method).toBe("GET");
+        expect(response).toEqual(ReverseGeocode); // this introspects the entire response
+        done();
+      })
+      .catch(e => {
+        fail(e);
+      });
+  });
+
+  it("should make a reverse geocoding request and translate lat/long JSON objects", done => {
+    fetchMock.once("*", ReverseGeocode);
+
+    reverseGeocode({ longitude: -118.409, latitude: 33.9425 })
+      .then(response => {
+        expect(fetchMock.called()).toEqual(true);
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual(
+          "https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer/reverseGeocode"
+        );
+        expect(options.method).toBe("POST");
+        expect(options.body).toContain("f=json");
+        expect(options.body).toContain(
+          `location=${encodeURIComponent("-118.409,33.9425")}`
+        );
+        expect(response).toEqual(ReverseGeocode); // this introspects the entire response
+        done();
+      })
+      .catch(e => {
+        fail(e);
+      });
+  });
+
+  it("should make a reverse geocoding request and translate lat/long JSON abbreviated objects", done => {
+    fetchMock.once("*", ReverseGeocode);
+
+    reverseGeocode({ lat: 33.9425, long: -118.409 })
+      .then(response => {
+        expect(fetchMock.called()).toEqual(true);
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual(
+          "https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer/reverseGeocode"
+        );
+        expect(options.method).toBe("POST");
+        expect(options.body).toContain("f=json");
+        expect(options.body).toContain(
+          `location=${encodeURIComponent("-118.409,33.9425")}`
+        );
+        expect(response).toEqual(ReverseGeocode); // this introspects the entire response
+        done();
+      })
+      .catch(e => {
+        fail(e);
+      });
+  });
+
+  it("should make a reverse geocoding request and translate a raw long,lat array", done => {
+    fetchMock.once("*", ReverseGeocode);
+
+    reverseGeocode([-118, 34])
+      .then(response => {
+        expect(fetchMock.called()).toEqual(true);
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual(
+          "https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer/reverseGeocode"
+        );
+        expect(options.method).toBe("POST");
+        expect(options.body).toContain("f=json");
+        expect(options.body).toContain(
+          `location=${encodeURIComponent("-118,34")}`
+        );
+        expect(response).toEqual(ReverseGeocode); // this introspects the entire response
+        done();
+      })
+      .catch(e => {
+        fail(e);
+      });
+  });
+});

package/packages/arcgis-rest-geocoding/test/suggest.test.ts

@@ -0,0 +1,53 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { suggest } from "../src/suggest";
+import * as fetchMock from "fetch-mock";
+import { Suggest } from "./mocks/responses";
+
+describe("geocode", () => {
+  afterEach(fetchMock.restore);
+
+  it("should make a request for suggestions", done => {
+    fetchMock.once("*", Suggest);
+
+    suggest("LAX")
+      .then(response => {
+        expect(fetchMock.called()).toEqual(true);
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual(
+          "https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer/suggest"
+        );
+        expect(options.method).toBe("POST");
+        expect(options.body).toContain("f=json");
+        expect(options.body).toContain("text=LAX");
+        expect(response).toEqual(Suggest); // this introspects the entire response
+        done();
+      })
+      .catch(e => {
+        fail(e);
+      });
+  });
+
+  it("should make a request for suggestions with other parameters", done => {
+    fetchMock.once("*", Suggest);
+
+    suggest("LAX", { params: { category: "Address,Postal" } })
+      .then(response => {
+        expect(fetchMock.called()).toEqual(true);
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual(
+          "https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer/suggest"
+        );
+        expect(options.method).toBe("POST");
+        expect(options.body).toContain("f=json");
+        expect(options.body).toContain("text=LAX");
+        expect(options.body).toContain("category=Address%2CPostal");
+        expect(response).toEqual(Suggest); // this introspects the entire response
+        done();
+      })
+      .catch(e => {
+        fail(e);
+      });
+  });
+});

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

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

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

@@ -0,0 +1,73 @@
+[![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-portal.svg?style=flat-square
+[npm-url]: https://www.npmjs.com/package/@esri/arcgis-rest-portal
+[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-portal/dist/umd/portal.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-portal
+
+> A module for working with ArcGIS Online and Enterprise content via the REST API that runs in Node.js and modern browsers.
+
+### Example
+
+```bash
+npm install @esri/arcgis-rest-request
+npm install @esri/arcgis-rest-portal
+```
+
+```js
+import { getItem } from '@esri/arcgis-rest-portal';
+
+const itemId = "30e5fe3149c34df1ba922e6f5bbf808f";
+
+getItem(itemId)
+    .then(response => {
+        console.log(response.title) // World Topographic Map
+    });
+```
+
+### [API Reference](https://esri.github.io/arcgis-rest-js/api/portal/)
+
+### 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; 2017-2019 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-portal/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "@esri/arcgis-rest-portal",
+  "version": "3.3.0",
+  "description": "ArcGIS Online and Enterprise content and user helpers for @esri/arcgis-rest-request",
+  "main": "dist/node/index.js",
+  "unpkg": "dist/umd/portal.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",
+    "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-portal"
+  },
+  "contributors": [
+    {
+      "name": "Dave Bouwman",
+      "email": "dbouwman@esri.com",
+      "url": "http://blog.davebouwman.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-portal/src/groups/add-users.ts

@@ -0,0 +1,140 @@
+/* Copyright (c) 2017-2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import {
+  request,
+  IRequestOptions,
+  ArcGISRequestError
+} from "@esri/arcgis-rest-request";
+
+import { getPortalUrl } from "../util/get-portal-url";
+import { chunk } from "../util/array";
+
+export interface IAddGroupUsersOptions extends IRequestOptions {
+  /**
+   * Group ID
+   */
+  id: string;
+  /**
+   * An array of usernames to be added to the group as group members
+   */
+  users?: string[];
+  /**
+   * An array of usernames to be added to the group as group admins
+   */
+  admins?: string[];
+}
+
+export interface IAddGroupUsersResult {
+  /**
+   * An array of usernames that were not added
+   */
+  notAdded?: string[];
+  /**
+   * An array of request errors
+   */
+  errors?: ArcGISRequestError[];
+}
+
+/**
+ * ```js
+ * import { addGroupUsers } from "@esri/arcgis-rest-portal";
+ * //
+ * addGroupUsers({
+ *   id: groupId,
+ *   users: ["username1", "username2"],
+ *   admins: ["username3"],
+ *   authentication
+ * })
+ * .then(response);
+ * ```
+ * Add users to a group. See the [REST Documentation](https://developers.arcgis.com/rest/users-groups-and-items/add-users-to-group.htm) for more information.
+ *
+ * @param requestOptions  - Options for the request
+ * @returns A Promise
+ */
+export function addGroupUsers(
+  requestOptions: IAddGroupUsersOptions
+): Promise<IAddGroupUsersResult> {
+  const id = requestOptions.id;
+  const url = `${getPortalUrl(requestOptions)}/community/groups/${id}/addUsers`;
+  const baseOptions = Object.assign({}, requestOptions, {
+    admins: undefined,
+    users: undefined
+  });
+
+  const batchRequestOptions = [
+    ..._prepareRequests("users", requestOptions.users, baseOptions),
+    ..._prepareRequests("admins", requestOptions.admins, baseOptions)
+  ];
+
+  const promises = batchRequestOptions.map(options =>
+    _sendSafeRequest(url, options)
+  );
+
+  return Promise.all(promises).then(_consolidateRequestResults);
+}
+
+function _prepareRequests(
+  type: "admins" | "users",
+  usernames: string[],
+  baseOptions: IAddGroupUsersOptions
+): IAddGroupUsersOptions[] {
+  if (!usernames || usernames.length < 1) {
+    return [];
+  }
+
+  // the ArcGIS REST API only allows to add no more than 25 users per request,
+  // see https://developers.arcgis.com/rest/users-groups-and-items/add-users-to-group.htm
+  const userChunks: string[][] = chunk<string>(usernames, 25);
+
+  return userChunks.map(users =>
+    _generateRequestOptions(type, users, baseOptions)
+  );
+}
+
+function _generateRequestOptions(
+  type: "admins" | "users",
+  usernames: string[],
+  baseOptions: IAddGroupUsersOptions
+) {
+  return Object.assign({}, baseOptions, {
+    [type]: usernames,
+    params: {
+      ...baseOptions.params,
+      [type]: usernames
+    }
+  });
+}
+
+// this request is safe since the request error will be handled
+function _sendSafeRequest(
+  url: string,
+  requestOptions: IAddGroupUsersOptions
+): Promise<IAddGroupUsersResult> {
+  return request(url, requestOptions).catch(error => {
+    return {
+      errors: [error]
+    };
+  });
+}
+
+function _consolidateRequestResults(
+  results: IAddGroupUsersResult[]
+): IAddGroupUsersResult {
+  const notAdded = results
+    .filter(result => result.notAdded)
+    .reduce((collection, result) => collection.concat(result.notAdded), []);
+
+  const errors = results
+    .filter(result => result.errors)
+    .reduce((collection, result) => collection.concat(result.errors), []);
+
+  const consolidated: IAddGroupUsersResult = { notAdded };
+
+  if (errors.length > 0) {
+    consolidated.errors = errors;
+  }
+
+  return consolidated;
+}

package/packages/arcgis-rest-portal/src/groups/create.ts

@@ -0,0 +1,43 @@
+/* Copyright (c) 2017-2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { request, IRequestOptions } from "@esri/arcgis-rest-request";
+import { IGroupAdd, IGroup } from "@esri/arcgis-rest-types";
+
+import { getPortalUrl } from "../util/get-portal-url";
+
+export interface ICreateGroupOptions extends IRequestOptions {
+  group: IGroupAdd;
+}
+
+/**
+ * ```js
+ * import { createGroup } from "@esri/arcgis-rest-portal";
+ * //
+ * createGroup({
+ *   group: {
+ *     title: "No Homers",
+ *     access: "public"
+ *   },
+ *   authentication
+ * })
+ *   .then(response)
+ * ```
+ * Create a new Group. See the [REST Documentation](https://developers.arcgis.com/rest/users-groups-and-items/create-group.htm) for more information.
+ *
+ * Note: The group name must be unique within the user's organization.
+ * @param requestOptions  - Options for the request, including a group object
+ * @returns A Promise that will resolve with the success/failure status of the request
+ */
+export function createGroup(
+  requestOptions: ICreateGroupOptions
+): Promise<{ success: boolean; group: IGroup }> {
+  const url = `${getPortalUrl(requestOptions)}/community/createGroup`;
+
+  requestOptions.params = {
+    ...requestOptions.params,
+    ...requestOptions.group
+  };
+
+  return request(url, requestOptions);
+}

package/packages/arcgis-rest-portal/src/groups/get.ts

@@ -0,0 +1,184 @@
+/* Copyright (c) 2017-2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import {
+  request,
+  IRequestOptions,
+  appendCustomParams
+} from "@esri/arcgis-rest-request";
+import { IPagingParams, IGroup, IItem, IUser } from "@esri/arcgis-rest-types";
+import { getPortalUrl } from "../util/get-portal-url";
+
+export interface IGroupCategorySchema {
+  categorySchema: IGroupCategory[];
+}
+
+export interface IGroupCategory {
+  title: string;
+  description?: string;
+  categories?: IGroupCategory[];
+}
+
+export interface IGetGroupContentOptions extends IRequestOptions {
+  paging: IPagingParams;
+}
+
+export interface IGroupContentResult {
+  total: number;
+  start: number;
+  num: number;
+  nextStart: number;
+  items: IItem[];
+}
+
+export interface IGroupUsersResult {
+  owner: string;
+  admins: string[];
+  users: string[];
+}
+
+/**
+ * ```js
+ * import { getGroup } from "@esri/arcgis-rest-portal";
+ * //
+ * getGroup("fxb988") // id
+ *   .then(response)
+ * ```
+ * Fetch a group using its id. See the [REST Documentation](https://developers.arcgis.com/rest/users-groups-and-items/group.htm) for more information.
+ *
+ * @param id - Group Id
+ * @param requestOptions  - Options for the request
+ * @returns  A Promise that will resolve with the data from the response.
+ */
+export function getGroup(
+  id: string,
+  requestOptions?: IRequestOptions
+): Promise<IGroup> {
+  const url = `${getPortalUrl(requestOptions)}/community/groups/${id}`;
+  // default to a GET request
+  const options: IRequestOptions = {
+    ...{ httpMethod: "GET" },
+    ...requestOptions
+  };
+  return request(url, options);
+}
+
+/**
+ * Gets the category schema set on a group
+ *
+ * @param id - Group Id
+ * @param requestOptions  - Options for the request
+ * @returns A promise that will resolve with JSON of group's category schema
+ * @see https://developers.arcgis.com/rest/users-groups-and-items/group-category-schema.htm
+ */
+export function getGroupCategorySchema(
+  id: string,
+  requestOptions?: IRequestOptions
+): Promise<IGroupCategorySchema> {
+  const url = `${getPortalUrl(
+    requestOptions
+  )}/community/groups/${id}/categorySchema`;
+
+  // default to a GET request
+  const options: IRequestOptions = {
+    ...{ httpMethod: "GET" },
+    ...requestOptions
+  };
+  return request(url, options);
+}
+
+/**
+ * Returns the content of a Group. Since the group may contain 1000s of items
+ * the requestParams allow for paging.
+ * @param id - Group Id
+ * @param requestOptions  - Options for the request, including paging parameters.
+ * @returns  A Promise that will resolve with the content of the group.
+ */
+export function getGroupContent(
+  id: string,
+  requestOptions?: IGetGroupContentOptions
+): Promise<IGroupContentResult> {
+  const url = `${getPortalUrl(requestOptions)}/content/groups/${id}`;
+
+  // default to a GET request
+  const options: IRequestOptions = {
+    ...{ httpMethod: "GET" },
+    params: { start: 1, num: 100 },
+    ...requestOptions
+  } as IGetGroupContentOptions;
+
+  // is this the most concise way to mixin with the defaults above?
+  if (requestOptions && requestOptions.paging) {
+    options.params = { ...requestOptions.paging };
+  }
+
+  return request(url, options);
+}
+
+/**
+ * Get the usernames of the admins and members. Does not return actual 'User' objects. Those must be
+ * retrieved via separate calls to the User's API.
+ * @param id - Group Id
+ * @param requestOptions - Options for the request
+ * @returns A Promise that will resolve with arrays of the group admin usernames and the member usernames
+ */
+export function getGroupUsers(
+  id: string,
+  requestOptions?: IRequestOptions
+): Promise<IGroupUsersResult> {
+  const url = `${getPortalUrl(requestOptions)}/community/groups/${id}/users`;
+  // default to a GET request
+  const options: IRequestOptions = {
+    ...{ httpMethod: "GET" },
+    ...requestOptions
+  };
+  return request(url, options);
+}
+
+export interface ISearchGroupUsersOptions
+  extends IRequestOptions,
+    IPagingParams {
+  name?: string;
+  sortField?: string;
+  sortOrder?: string;
+  joined?: number | number[];
+  memberType?: string;
+  [key: string]: any;
+}
+
+export interface ISearchGroupUsersResult {
+  total: number;
+  start: number;
+  num: number;
+  nextStart: number;
+  owner: IUser;
+  users: any[];
+}
+
+/**
+ * ```js
+ * import { searchGroupUsers } from "@esri/arcgis-rest-portal";
+ * //
+ * searchGroupUsers('abc123')
+ *   .then(response)
+ * ```
+ * Search the users in a group. See the [REST Documentation](https://developers.arcgis.com/rest/users-groups-and-items/group-users-list.htm) for more information.
+ *
+ * @param id - The group id
+ * @param searchOptions - Options for the request, including paging parameters.
+ * @returns A Promise that will resolve with the data from the response.
+ */
+export function searchGroupUsers(
+  id: string,
+  searchOptions?: ISearchGroupUsersOptions
+): Promise<ISearchGroupUsersResult> {
+  const url = `${getPortalUrl(searchOptions)}/community/groups/${id}/userlist`;
+  const options = appendCustomParams<ISearchGroupUsersOptions>(
+    searchOptions || {},
+    ["name", "num", "start", "sortField", "sortOrder", "joined", "memberType"],
+    {
+      httpMethod: "GET"
+    }
+  );
+  return request(url, options);
+}