delectusnon 1.0.0

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

@@ -0,0 +1,193 @@
+/* Copyright (c) 2018 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 seperate arrays of non objects", () => {
+    const params = {
+      foo: ["bar", "baz"]
+    };
+
+    const expected = {
+      foo: "bar,baz"
+    };
+
+    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/tsconfig.json

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

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

@@ -0,0 +1,67 @@
+[![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-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
+
+# @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,57 @@
+{
+  "name": "@esri/arcgis-rest-sharing",
+  "version": "1.13.0",
+  "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"
+  },
+  "peerDependencies": {
+    "@esri/arcgis-rest-auth": "^1.11.0",
+    "@esri/arcgis-rest-common-types": "^1.11.0",
+    "@esri/arcgis-rest-groups": "^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-groups": "^1.13.0",
+    "@esri/arcgis-rest-request": "^1.13.0"
+  },
+  "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"
+  },
+  "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);
+}

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

@@ -0,0 +1,211 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { request, getPortalUrl } from "@esri/arcgis-rest-request";
+import { IItem } from "@esri/arcgis-rest-common-types";
+
+import {
+  ISharingRequestOptions,
+  ISharingResponse,
+  isOrgAdmin,
+  getUserMembership
+} from "./helpers";
+
+export interface IGroupSharingRequestOptions extends ISharingRequestOptions {
+  /**
+   * Group identifier
+   */
+  groupId: string;
+  confirmItemControl?: boolean;
+}
+
+interface IGroupSharingUnsharingRequestOptions
+  extends IGroupSharingRequestOptions {
+  action: "share" | "unshare";
+}
+
+/**
+ * Share an item with a group.
+ *
+ * ```js
+ * import { shareItemWithGroup } from '@esri/arcgis-rest-sharing';
+ *
+ * shareItemWithGroup({
+ *   id: "abc123",
+ *   groupId: "xyz987",
+ *   authentication: session
+ * })
+ * ```
+ *
+ * @param requestOptions - Options for the request.
+ * @returns A Promise that will resolve with the data from the response.
+ */
+export function shareItemWithGroup(
+  requestOptions: IGroupSharingRequestOptions
+): Promise<ISharingResponse> {
+  return changeGroupSharing({ action: "share", ...requestOptions });
+}
+
+/**
+ * Stop sharing an item with a group.
+ *
+ * ```js
+ * import { unshareItemWithGroup } from '@esri/arcgis-rest-sharing';
+ *
+ * unshareItemWithGroup({
+ *   id: "abc123",
+ *   groupId: "xyz987",
+ *   authentication: session
+ * })
+ * ```
+ *
+ * @param requestOptions - Options for the request.
+ * @returns A Promise that will resolve with the data from the response.
+ */
+export function unshareItemWithGroup(
+  requestOptions: IGroupSharingRequestOptions
+): Promise<ISharingResponse> {
+  return changeGroupSharing({ action: "unshare", ...requestOptions });
+}
+
+/**
+ * @param requestOptions - Options for the request.
+ * @returns A Promise that will resolve with the data from the response.
+ */
+function changeGroupSharing(
+  requestOptions: IGroupSharingUnsharingRequestOptions
+): Promise<ISharingResponse> {
+  const username = requestOptions.authentication.username;
+  const owner = requestOptions.owner || username;
+
+  return isOrgAdmin(requestOptions).then(admin => {
+    const resultProp =
+      requestOptions.action === "share" ? "notSharedWith" : "notUnsharedFrom";
+    // check if the item has already been shared with the group...
+    return isItemSharedWithGroup(requestOptions).then(result => {
+      // console.log(admin);
+      // if we are sharing and result is true OR we are unsharing and result is false... short circuit
+      if (
+        (requestOptions.action === "share" && result === true) ||
+        (requestOptions.action === "unshare" && result === false)
+      ) {
+        // and send back the same response structure ArcGIS Online would
+        const response = { itemId: requestOptions.id, shortcut: true } as any;
+        response[resultProp] = [];
+        return response;
+      } else {
+        // next check to ensure the user is a member of the group
+        return getUserMembership(requestOptions)
+          .then(membership => {
+            if (membership === "nonmember") {
+              // abort and reject promise
+              throw Error(
+                `This item can not be ${
+                  requestOptions.action
+                }d by ${username} as they are not a member of the specified group ${
+                  requestOptions.groupId
+                }.`
+              );
+            } else {
+              // if orgAdmin or owner (and member of group) share using the owner url
+              if (owner === username || admin) {
+                return `${getPortalUrl(
+                  requestOptions
+                )}/content/users/${owner}/items/${requestOptions.id}/${
+                  requestOptions.action
+                }`;
+              } else {
+                // if they are a group admin/owner, use the bare item url
+                if (membership === "admin" || membership === "owner") {
+                  return `${getPortalUrl(requestOptions)}/content/items/${
+                    requestOptions.id
+                  }/${requestOptions.action}`;
+                } else {
+                  // otherwise abort
+                  throw Error(
+                    `This item can not be ${
+                      requestOptions.action
+                    }d by ${username} as they are neither the owner, a groupAdmin of ${
+                      requestOptions.groupId
+                    }, nor an org_admin.`
+                  );
+                }
+              }
+            }
+          })
+          .then(url => {
+            // now its finally time to do the sharing
+            requestOptions.params = {
+              groups: requestOptions.groupId,
+              confirmItemControl: requestOptions.confirmItemControl
+            };
+            // dont mixin to ensure that old query parameters from the search request arent included
+            return request(url, requestOptions);
+          })
+          .then(sharingResponse => {
+            if (sharingResponse[resultProp].length) {
+              throw Error(
+                `Item ${requestOptions.id} could not be ${
+                  requestOptions.action
+                }d to group ${requestOptions.groupId}.`
+              );
+            } else {
+              // all is well
+              return sharingResponse;
+            }
+          });
+      } // else
+    }); // then
+  });
+}
+
+/**
+ * Find out whether or not an item is already shared with a group.
+ *
+ * @param requestOptions - Options for the request.
+ * @returns A Promise that will resolve with the data from the response.
+ */
+function isItemSharedWithGroup(
+  requestOptions: IGroupSharingRequestOptions
+): Promise<boolean> {
+  const query = {
+    q: `id: ${requestOptions.id} AND group: ${requestOptions.groupId}`,
+    start: 1,
+    num: 10,
+    sortField: "title"
+  };
+
+  // we need to append some params into requestOptions, so make a clone
+  // instead of mutating the params on the inbound requestOptions object
+  const options = { ...requestOptions };
+  // instead of calling out to "@esri/arcgis-rest-items, make the request manually to forgoe another dependency
+  options.params = {
+    ...query,
+    ...requestOptions.params
+  };
+
+  const url = `${getPortalUrl(options)}/search`;
+
+  return request(url, options).then(searchResponse => {
+    // if there are no search results at all, we know the item hasnt already been shared with the group
+    if (searchResponse.total === 0) {
+      return false;
+    } else {
+      let sharedItem: IItem;
+      // otherwise loop through and search for the id
+      searchResponse.results.some((item: IItem) => {
+        const matchedItem = item.id === requestOptions.id;
+        if (matchedItem) {
+          sharedItem = item;
+        }
+        return matchedItem;
+      });
+
+      if (sharedItem) {
+        return true;
+      } else {
+        return false;
+      }
+    }
+  });
+}