delectusnon 1.0.0

package/packages/arcgis-rest-geocoder/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.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.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.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.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.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-geocoder/test/suggest.test.ts

@@ -0,0 +1,77 @@
+/* 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.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 magic key", done => {
+    fetchMock.once("*", Suggest);
+
+    suggest("LAX", { magicKey: "foo" })
+      .then(response => {
+        expect(fetchMock.called()).toEqual(true);
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual(
+          "https://geocode.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("magicKey=foo");
+        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.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-geocoder/tsconfig.json

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

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

@@ -0,0 +1,64 @@
+[![npm version][npm-img]][npm-url]
+[![build status][travis-img]][travis-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-groups.svg?style=flat-square
+[npm-url]: https://www.npmjs.com/package/@esri/arcgis-rest-groups
+[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
+
+# @esri/arcgis-rest-groups
+
+> A module for working with groups in the ArcGIS REST API that runs in Node.js and modern browsers.
+
+### Example
+
+```bash
+npm install @esri/arcgis-rest-request
+npm install @esri/arcgis-rest-groups
+```
+
+```js
+import { searchGroups } from '@esri/arcgis-rest-groups';
+
+searchGroups({q:"water"})
+    .then(response => {
+        console.log(response.results.length) // 10
+    });
+```
+
+### [API Reference](https://esri.github.io/arcgis-rest-js/api/groups/)
+
+### 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; 2017-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-groups/package-lock.json

@@ -0,0 +1,11 @@
+{
+	"requires": true,
+	"lockfileVersion": 1,
+	"dependencies": {
+		"tslib": {
+			"version": "1.8.0",
+			"resolved": "https://registry.npmjs.org/tslib/-/tslib-1.8.0.tgz",
+			"integrity": "sha512-ymKWWZJST0/CkgduC2qkzjMOWr4bouhuURNXCn/inEX0L57BnRG6FhX76o7FOnsjHazCjfU2LKeSrlS2sIKQJg=="
+		}
+	}
+}

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

@@ -0,0 +1,52 @@
+{
+  "name": "@esri/arcgis-rest-groups",
+  "version": "1.13.0",
+  "description": "Portal Group helpers for @esri/arcgis-rest-request",
+  "main": "dist/node/index.js",
+  "browser": "dist/umd/groups.umd.js",
+  "module": "dist/esm/index.js",
+  "js:next": "dist/esm/index.js",
+  "types": "dist/esm/index.d.ts",
+  "license": "Apache-2.0",
+  "files": [
+    "dist/**"
+  ],
+  "dependencies": {
+    "tslib": "^1.7.1"
+  },
+  "peerDependencies": {
+    "@esri/arcgis-rest-auth": "^1.11.0",
+    "@esri/arcgis-rest-common-types": "^1.11.0",
+    "@esri/arcgis-rest-request": "^1.11.0"
+  },
+  "devDependencies": {
+    "@esri/arcgis-rest-auth": "^1.13.0",
+    "@esri/arcgis-rest-common-types": "^1.13.0",
+    "@esri/arcgis-rest-request": "^1.13.0"
+  },
+  "scripts": {
+    "prepare": "npm run build",
+    "build": "npm run build:node && npm run build:umd && npm run build:esm",
+    "build:esm": "tsc -p ./tsconfig.json --module es2015 --outDir ./dist/esm --declaration",
+    "build:umd": "rollup -c ../../umd-base-profile.js && rollup -c ../../umd-production-profile.js",
+    "build:node": "tsc -p ./tsconfig.json --module commonjs --outDir ./dist/node"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Esri/arcgis-rest-js.git"
+  },
+  "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"
+}

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

@@ -0,0 +1,34 @@
+/* Copyright (c) 2017-2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import {
+  request,
+  IRequestOptions,
+  getPortalUrl
+} from "@esri/arcgis-rest-request";
+
+import { IGroupAdd } from "@esri/arcgis-rest-common-types";
+
+import { serializeGroup } from "./helpers";
+
+export interface IGroupAddRequestOptions extends IRequestOptions {
+  group: IGroupAdd;
+}
+
+/**
+ * Create a new Group.
+ * 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: IGroupAddRequestOptions
+): Promise<any> {
+  const url = `${getPortalUrl(requestOptions)}/community/createGroup`;
+  const options: IGroupAddRequestOptions = {
+    ...requestOptions
+  };
+  // serialize the group into something Portal will accept
+  options.params = serializeGroup(requestOptions.group);
+  return request(url, options);
+}

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

@@ -0,0 +1,95 @@
+/* Copyright (c) 2017-2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import {
+  request,
+  IRequestOptions,
+  getPortalUrl
+} from "@esri/arcgis-rest-request";
+
+import { IPagingParams, IGroup, IItem } from "@esri/arcgis-rest-common-types";
+
+export interface IPagingParamsRequestOptions 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[];
+}
+
+/**
+ *
+ * @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);
+}
+
+/**
+ * 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?: IPagingParamsRequestOptions
+): Promise<IGroup> {
+  const url = `${getPortalUrl(requestOptions)}/content/groups/${id}`;
+
+  // default to a GET request
+  const options: IRequestOptions = {
+    ...{ httpMethod: "GET" },
+    params: { start: 1, num: 100 },
+    ...requestOptions
+  } as IPagingParamsRequestOptions;
+
+  // 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);
+}

package/packages/arcgis-rest-groups/src/helpers.ts

@@ -0,0 +1,26 @@
+/* Copyright (c) 2017-2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+
+import { IItemUpdate, IGroupAdd, IGroup } from "@esri/arcgis-rest-common-types";
+
+export interface IGroupIdRequestOptions extends IRequestOptions {
+  id: string;
+}
+
+/**
+ * Serialize a group into a json format accepted by the Portal API
+ * for create and update operations
+ *
+ * @param group IGroup to be serialized
+ * @returns a formatted JSON object to be sent to Portal
+ * @private
+ */
+export function serializeGroup(group: IGroupAdd | IItemUpdate | IGroup): any {
+  // create a clone so we're not messing with the original
+  const clone = JSON.parse(JSON.stringify(group));
+  // join and tags...
+  clone.tags = clone.tags.join(", ");
+  return clone;
+}

package/packages/arcgis-rest-groups/src/index.ts

@@ -0,0 +1,11 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+export * from "./create";
+export * from "./get";
+export * from "./helpers";
+export * from "./notification";
+export * from "./protect";
+export * from "./remove";
+export * from "./search";
+export * from "./update";

package/packages/arcgis-rest-groups/src/notification.ts

@@ -0,0 +1,77 @@
+/* Copyright (c) 2017-2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { request, getPortalUrl } from "@esri/arcgis-rest-request";
+import { IGroupIdRequestOptions } from "./helpers";
+
+export type NotificationChannelType = "push" | "email" | "builtin";
+
+export interface IGroupNotificationRequestOptions
+  extends IGroupIdRequestOptions {
+  /**
+   * Subject of the notification. This only applies to email and builtin notifications. For push notifications, subject/title is provided as a part of the message payload.
+   */
+  subject?: string;
+  /**
+   * Message to be sent. For builtin and email notifications this is a string. For push notifications, this will be JSON.
+   */
+  message: string | object;
+  /**
+   * Array of usernames of the users in the group to whom the message should be sent. If not provided, the message will be sent to all users in the group if the user is an admin. Only group admins will be able to send notifications to a list of users. Group users will be able to send notifications to only one user at a time.
+   */
+  users?: string[];
+  /**
+   * The channel through which the notification is to be delivered. Supported values are push, email, or builtin. If push is chosen, a message will be delivered only to those group members that have registered their devices to receive push notifications. If the user has registered more than one device for the app, then message will be sent to all the registered devices. Email will be sent when the email option is chosen. If the builtin option is chosen, a notification will be added to the notifications list that the user can see when logged into the home app.
+   */
+  notificationChannelType?: NotificationChannelType;
+  /**
+   * ClientId of the application through which user receives messages on the mobile device. This only applies to push notifications.
+   */
+  clientId?: string;
+  /**
+   * This only applies to push notifications. When set to true, message will be delivered to the app and it will not show as an alert to the user.
+   */
+  silentNotification?: boolean;
+}
+
+/**
+ * Create a group notification.
+ *
+ * ```js
+ * import { createGroupNotification } from '@esri/arcgis-rest-groups';
+ *
+ * // send an email to an entire group
+ * createGroupNotification({
+ *   authentication: UserSession,
+ *   subject: "hello",
+ *   message: "world!",
+ *   id: groupId
+ * })
+ * ```
+ * @param requestOptions - Options for the request
+ *
+ * @returns A Promise that will resolve with the success/failure status of the request
+ */
+export function createGroupNotification(
+  requestOptions: IGroupNotificationRequestOptions
+): Promise<any> {
+  const url = `${getPortalUrl(requestOptions)}/community/groups/${
+    requestOptions.id
+  }/createNotification`;
+
+  const options: IGroupNotificationRequestOptions = {
+    params: {
+      subject: requestOptions.subject,
+      message: requestOptions.message,
+      users: requestOptions.users,
+      notificationChannelType:
+        requestOptions.notificationChannelType || "email",
+      clientId: requestOptions.clientId,
+      silentNotification: requestOptions.silentNotification,
+      notifyAll: !requestOptions.users || requestOptions.users.length === 0,
+      ...requestOptions.params
+    },
+    ...requestOptions
+  };
+  return request(url, options);
+}

package/packages/arcgis-rest-groups/src/protect.ts

@@ -0,0 +1,40 @@
+/* Copyright (c) 2017-2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { request, getPortalUrl } from "@esri/arcgis-rest-request";
+
+import { IGroupIdRequestOptions } from "./helpers";
+
+/**
+ * Protect a Group. This simply means a user must unprotect the group prior to deleting it
+ * @param requestOptions - Options for the request
+ * @returns A Promise that will resolve with the success/failure status of the request
+ */
+export function protectGroup(
+  requestOptions: IGroupIdRequestOptions
+): Promise<any> {
+  const url = `${getPortalUrl(requestOptions)}/community/groups/${
+    requestOptions.id
+  }/protect`;
+  const options: IGroupIdRequestOptions = {
+    ...requestOptions
+  };
+  return request(url, options);
+}
+
+/**
+ * Unprotect a Group.
+ * @param requestOptions - Options for the request
+ * @returns A Promise that will resolve with the success/failure status of the request
+ */
+export function unprotectGroup(
+  requestOptions: IGroupIdRequestOptions
+): Promise<any> {
+  const url = `${getPortalUrl(requestOptions)}/community/groups/${
+    requestOptions.id
+  }/unprotect`;
+  const options: IGroupIdRequestOptions = {
+    ...requestOptions
+  };
+  return request(url, options);
+}

package/packages/arcgis-rest-groups/src/remove.ts

@@ -0,0 +1,23 @@
+/* Copyright (c) 2017-2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { request, getPortalUrl } from "@esri/arcgis-rest-request";
+
+import { IGroupIdRequestOptions } from "./helpers";
+
+/**
+ * Delete a group.
+ * @param requestOptions - Options for the request
+ * @returns A Promise that will resolve with the success/failure status of the request
+ */
+export function removeGroup(
+  requestOptions: IGroupIdRequestOptions
+): Promise<any> {
+  const url = `${getPortalUrl(requestOptions)}/community/groups/${
+    requestOptions.id
+  }/delete`;
+  const options: IGroupIdRequestOptions = {
+    ...requestOptions
+  };
+  return request(url, options);
+}