ducimusipsa 1.0.0

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

@@ -0,0 +1,74 @@
+[![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-users.svg?style=flat-square
+[npm-url]: https://www.npmjs.com/package/@esri/arcgis-rest-users
+[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-users
+
+> A module for working with users in the ArcGIS REST API that runs in Node.js and modern browsers.
+
+### Example
+
+```bash
+npm install @esri/arcgis-rest-users
+```
+
+```js
+import { getUser } from '@esri/arcgis-rest-groups';
+
+getUser("jsmith")
+    .then(response => {
+        /*
+        {
+            firstName: "John",
+            lastName: "Smith",
+            tags: ["GIS Analyst", "City of Redlands"],
+            thumbnail: "myProfile.jpg",
+            created: 1258501046000,
+            modified: 1290625562000,
+             d eetc.
+        };
+        */
+    });
+```
+
+### 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 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-users/package-lock.json

@@ -0,0 +1,11 @@
+{
+	"requires": true,
+	"lockfileVersion": 1,
+	"dependencies": {
+		"tslib": {
+			"version": "1.9.0",
+			"resolved": "https://registry.npmjs.org/tslib/-/tslib-1.9.0.tgz",
+			"integrity": "sha512-f/qGG2tUkrISBlQZEjEqoZ3B2+npJjIf04H1wuAv9iA8i04Icp+61KRXxFdha22670NJopsZCIjhC3SnjPRKrQ=="
+		}
+	}
+}

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

@@ -0,0 +1,54 @@
+{
+  "name": "@esri/arcgis-rest-users",
+  "version": "1.14.1",
+  "description": "Portal user helpers for @esri/arcgis-rest-request",
+  "main": "dist/node/index.js",
+  "browser": "dist/umd/users.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"
+  },
+  "devDependencies": {
+    "@esri/arcgis-rest-auth": "^1.14.1",
+    "@esri/arcgis-rest-common-types": "^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-request": "^1.14.1"
+  },
+  "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",
+    "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"
+    }
+  ],
+  "bugs": {
+    "url": "https://github.com/Esri/arcgis-rest-js/issues"
+  },
+  "homepage": "https://github.com/Esri/arcgis-rest-js#readme"
+}

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

@@ -0,0 +1,69 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import {
+  request,
+  IRequestOptions,
+  getPortalUrl
+} from "@esri/arcgis-rest-request";
+
+import { IUser } from "@esri/arcgis-rest-common-types";
+import { UserSession } from "@esri/arcgis-rest-auth";
+
+export interface IGetUserRequestOptions extends IRequestOptions {
+  /**
+   * A session representing a logged in user.
+   */
+  authentication?: UserSession;
+  /**
+   * Supply a username if you'd like to fetch information about a different user than is being used to authenticate the request.
+   */
+  username?: string;
+}
+
+/**
+ * Get information about a user. This method has proven so generically useful that you can also call [`UserSession.getUser()`](../../auth/UserSession#getUser-summary).
+ *
+ * ```js
+ * import { getUser } from '@esri/arcgis-rest-users';
+ *
+ * getUser("jsmith")
+ *   .then(
+ *     results => {
+ *      // {
+ *      //   firstName: "John",
+ *      //   lastName: "Smith",
+ *      //   tags: ["GIS Analyst", "City of Redlands"],
+ *      //   created: 1258501046000
+ *      //   etc.
+ *      // };
+ *   })
+ * ```
+ *
+ * @param requestOptions - options to pass through in the request
+ * @returns A Promise that will resolve with metadata about the user
+ */
+export function getUser(
+  requestOptions?: string | IGetUserRequestOptions
+): Promise<IUser> {
+  let url;
+  let options = { httpMethod: "GET" } as IGetUserRequestOptions;
+
+  // if a username is passed, assume ArcGIS Online
+  if (typeof requestOptions === "string") {
+    url = `https://www.arcgis.com/sharing/rest/community/users/${requestOptions}`;
+  } else {
+    // if an authenticated session is passed, default to that user/portal unless another username is provided manually
+    const username =
+      requestOptions.username || requestOptions.authentication.username;
+    url = `${getPortalUrl(requestOptions)}/community/users/${encodeURIComponent(
+      username
+    )}`;
+    options = {
+      ...requestOptions,
+      ...options
+    };
+  }
+  // send the request
+  return request(url, options);
+}

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

@@ -0,0 +1,6 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+export * from "./get";
+export * from "./notification";
+export * from "./invitation";

package/packages/arcgis-rest-users/src/invitation.ts

@@ -0,0 +1,166 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { request, getPortalUrl } from "@esri/arcgis-rest-request";
+
+import { IUserRequestOptions } from "@esri/arcgis-rest-auth";
+import { IGroup } from "@esri/arcgis-rest-common-types";
+
+export interface IInvitation {
+  id: string;
+  targetType: string;
+  targetId: string;
+  received: number;
+  accepted: boolean;
+  mustApprove: boolean;
+  email: string;
+  role: string;
+  type: string;
+  dateAccepted: number;
+  expiration: number;
+  created: number;
+  username: string;
+  fromUsername: {
+    username: string;
+    fullname?: string;
+  };
+  group?: IGroup;
+  groupId?: string;
+}
+
+export interface IInvitationResult {
+  userInvitations: IInvitation[];
+}
+
+/**
+ * Get all invitations for a user. See the [REST Documentation](https://developers.arcgis.com/rest/users-groups-and-items/user-invitations.htm) for more information.
+ *
+ * ```js
+ * import { getUserInvitations } from '@esri/arcgis-rest-users';
+ *
+ * // username is inferred from UserSession
+ * getUserInvitations({ authentication })
+ * .then((results) => {
+ *   console.log(results.userInvitations.length); // 3
+ * })
+ * ```
+ *
+ * @param requestOptions - options to pass through in the request
+ * @returns A Promise that will resolve with the user's invitations
+ */
+export function getUserInvitations(
+  requestOptions: IUserRequestOptions
+): Promise<IInvitationResult> {
+  let options = { httpMethod: "GET" } as IUserRequestOptions;
+
+  const username = encodeURIComponent(requestOptions.authentication.username);
+  const portalUrl = getPortalUrl(requestOptions);
+  const url = `${portalUrl}/community/users/${username}/invitations`;
+  options = { ...requestOptions, ...options };
+
+  // send the request
+  return request(url, options);
+}
+
+export interface IInvitationRequestOptions extends IUserRequestOptions {
+  invitationId: string;
+}
+
+/**
+ * Get an invitation for a user by id. See the [REST Documentation](https://developers.arcgis.com/rest/users-groups-and-items/user-invitation.htm) for more information.
+ *
+ * ```js
+ * import { getUserInvitation } from '@esri/arcgis-rest-users';
+ *
+ * // username is inferred from UserSession
+ * getUserInvitation({
+ *   invitationId: "3ef",
+ *   authentication
+ * })
+ *   .then((results) => {
+ *     console.log(results.accepted); // true
+ *   })
+ * ```
+ *
+ * @param requestOptions - options to pass through in the request
+ * @returns A Promise that will resolve with the invitation
+ */
+export function getUserInvitation(
+  requestOptions: IInvitationRequestOptions
+): Promise<IInvitation> {
+  const username = encodeURIComponent(requestOptions.authentication.username);
+  const portalUrl = getPortalUrl(requestOptions);
+  const url = `${portalUrl}/community/users/${username}/invitations/${
+    requestOptions.invitationId
+  }`;
+
+  let options = { httpMethod: "GET" } as IInvitationRequestOptions;
+  options = { ...requestOptions, ...options };
+
+  // send the request
+  return request(url, options);
+}
+
+/**
+ * Accept an invitation. See the [REST Documentation](https://developers.arcgis.com/rest/users-groups-and-items/accept-invitation.htm) for more information.
+ *
+ * ```js
+ * import { acceptInvitation } from '@esri/arcgis-rest-users';
+ *
+ * // username is inferred from UserSession
+ * acceptInvitation({
+ *   invitationId: "3ef",
+ *   authentication
+ * })
+ *   .then((response) => {
+ *     console.log(response.success); // true
+ *   })
+ * ```
+ *
+ * @param requestOptions - Options for the request
+ * @returns A Promise that will resolve with the success/failure status of the request
+ */
+export function acceptInvitation(
+  requestOptions: IInvitationRequestOptions
+): Promise<any> {
+  const username = encodeURIComponent(requestOptions.authentication.username);
+  const portalUrl = getPortalUrl(requestOptions);
+  const url = `${portalUrl}/community/users/${username}/invitations/${
+    requestOptions.invitationId
+  }/accept`;
+
+  const options: IInvitationRequestOptions = { ...requestOptions };
+  return request(url, options);
+}
+
+/**
+ * Decline an invitation. See the [REST Documentation](https://developers.arcgis.com/rest/users-groups-and-items/decline-invitation.htm) for more information.
+ *
+ * ```js
+ * import { declineInvitation } from '@esri/arcgis-rest-users';
+ *
+ * // username is inferred from UserSession
+ * declineInvitation({
+ *   invitationId: "3ef",
+ *   authentication
+ * })
+ *   .then((response) => {
+ *     console.log(response.success); // true
+ *   })
+ * ```
+ *
+ * @param requestOptions - Options for the request
+ * @returns A Promise that will resolve with the success/failure status of the request
+ */
+export function declineInvitation(
+  requestOptions: IInvitationRequestOptions
+): Promise<any> {
+  const username = encodeURIComponent(requestOptions.authentication.username);
+  const portalUrl = getPortalUrl(requestOptions);
+  const url = `${portalUrl}/community/users/${username}/invitations/${
+    requestOptions.invitationId
+  }/decline`;
+
+  const options: IInvitationRequestOptions = { ...requestOptions };
+  return request(url, options);
+}

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

@@ -0,0 +1,73 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { request, getPortalUrl } from "@esri/arcgis-rest-request";
+
+import { IUserRequestOptions } from "@esri/arcgis-rest-auth";
+
+export interface INotification {
+  id: string;
+  type: string;
+  target: string;
+  targetType: string;
+  received: number;
+  data: { [key: string]: any };
+}
+
+export interface INotificationIdRequestOptions extends IUserRequestOptions {
+  /**
+   * Unique identifier of the item.
+   */
+  id: string;
+}
+export interface INotificationResult {
+  notifications: INotification[];
+}
+
+/**
+ * Get notifications for a user.
+ *
+ * ```js
+ * import { getUserNotifications } from '@esri/arcgis-rest-users';
+ *
+ * // username is inferred from UserSession
+ * getUserNotifications({ authentication })
+ * .then((results) => {
+ *   console.log(results.notifications.length); // 3
+ * })
+ * ```
+ *
+ * @param requestOptions - options to pass through in the request
+ * @returns A Promise that will resolve with the user's notifications
+ */
+export function getUserNotifications(
+  requestOptions: IUserRequestOptions
+): Promise<INotificationResult> {
+  let options = { httpMethod: "GET" } as IUserRequestOptions;
+
+  const username = encodeURIComponent(requestOptions.authentication.username);
+  const portalUrl = getPortalUrl(requestOptions);
+  const url = `${portalUrl}/community/users/${username}/notifications`;
+  options = { ...requestOptions, ...options };
+
+  // send the request
+  return request(url, options);
+}
+
+/**
+ * Delete a notification.
+ *
+ * @param requestOptions - Options for the request
+ * @returns A Promise that will resolve with the success/failure status of the request
+ */
+export function removeNotification(
+  requestOptions: INotificationIdRequestOptions
+): Promise<any> {
+  const username = encodeURIComponent(requestOptions.authentication.username);
+  const portalUrl = getPortalUrl(requestOptions);
+  const url = `${portalUrl}/community/users/${username}/notifications/${
+    requestOptions.id
+  }/delete`;
+
+  return request(url, requestOptions);
+}

package/packages/arcgis-rest-users/test/get.test.ts

@@ -0,0 +1,99 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { getUser } from "../src/index";
+
+import {
+  AnonUserResponse,
+  GroupMemberUserResponse,
+  GroupAdminUserResponse
+} from "./mocks/user";
+
+import { UserSession } from "@esri/arcgis-rest-auth";
+import * as fetchMock from "fetch-mock";
+
+const TOMORROW = (function() {
+  const now = new Date();
+  now.setDate(now.getDate() + 1);
+  return now;
+})();
+
+describe("users", () => {
+  afterEach(fetchMock.restore);
+
+  describe("getUser", () => {
+    const session = new UserSession({
+      username: "c@sey",
+      password: "123456",
+      portal: "https://myorg.maps.arcgis.com/sharing/rest"
+    });
+
+    fetchMock.postOnce(
+      "https://myorg.maps.arcgis.com/sharing/rest/generateToken",
+      {
+        token: "token",
+        expires: TOMORROW.getTime(),
+        username: " c@sey"
+      }
+    );
+
+    session.refreshSession();
+
+    it("should make a simple, unauthenticated request for information about a user", done => {
+      fetchMock.once("*", AnonUserResponse);
+
+      getUser("jsmith")
+        .then(() => {
+          expect(fetchMock.called()).toEqual(true);
+          const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+          expect(url).toEqual(
+            "https://www.arcgis.com/sharing/rest/community/users/jsmith?f=json"
+          );
+          expect(options.method).toBe("GET");
+          done();
+        })
+        .catch(e => {
+          fail(e);
+        });
+    });
+
+    it("should make an authenticated request for information about a user", done => {
+      fetchMock.once("*", GroupMemberUserResponse);
+
+      getUser({ authentication: session })
+        .then(() => {
+          expect(fetchMock.called()).toEqual(true);
+          const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+          expect(url).toEqual(
+            "https://myorg.maps.arcgis.com/sharing/rest/community/users/c%40sey?f=json&token=token"
+          );
+          expect(options.method).toBe("GET");
+          done();
+        })
+        .catch(e => {
+          fail(e);
+        });
+    });
+
+    it("should make an authenticated request for information about a different user", done => {
+      fetchMock.once("*", GroupAdminUserResponse);
+
+      getUser({
+        username: "jsmith",
+        authentication: session
+      })
+        .then(() => {
+          expect(fetchMock.called()).toEqual(true);
+          const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+          expect(url).toEqual(
+            "https://myorg.maps.arcgis.com/sharing/rest/community/users/jsmith?f=json&token=token"
+          );
+          expect(options.method).toBe("GET");
+          done();
+        })
+        .catch(e => {
+          fail(e);
+        });
+    });
+  });
+});