etincidunt 1.0.0

package/packages/arcgis-rest-request/test/utils/encode-form-data.test.ts

@@ -0,0 +1,112 @@
+import { encodeFormData } from "../../src/utils/encode-form-data";
+import {
+  requiresFormData,
+  processParams
+} from "../../src/utils/process-params";
+import { attachmentFile } from "../../../arcgis-rest-feature-service/test/attachments.test";
+
+describe("encodeFormData", () => {
+  it("should encode in form data for multipart requests", () => {
+    const binaryObj =
+      typeof File !== "undefined"
+        ? new File(["foo"], "foo.txt", {
+            type: "text/plain"
+          })
+        : new Buffer("");
+
+    const formData = encodeFormData({ binary: binaryObj });
+
+    expect(formData instanceof FormData).toBeTruthy();
+  });
+
+  it("should encode as query string for basic types", () => {
+    const dateValue = 1471417200000;
+
+    // null, undefined, function are excluded. If you want to send an empty key you need to send an empty string "".
+    // See https://github.com/Esri/arcgis-rest-js/issues/18
+    const params = {
+      myArray1: new Array(8),
+      myArray2: [1, 2, 4, 16],
+      myArray3: [{ a: 1, b: 2 }, { c: "abc" }],
+      myDate: new Date(dateValue),
+      myFunction: () => {
+        return 3.1415;
+      },
+      myBoolean: true,
+      myString: "Hello, world!",
+      myEmptyString: "",
+      myNumber: 380
+    };
+
+    expect(requiresFormData(params)).toBeFalsy();
+
+    const formData = processParams(params);
+    expect(typeof formData).toBe("object");
+    expect(formData.myArray1).toBe(",,,,,,,");
+    expect(formData.myArray2).toBe("1,2,4,16");
+    expect(formData.myArray3).toBe('[{"a":1,"b":2},{"c":"abc"}]');
+    expect(formData.myDate).toBe(dateValue);
+    expect(formData.myBoolean).toBeTruthy();
+    expect(formData.myString).toBe("Hello, world!");
+    expect(formData.myEmptyString).toBe("");
+    expect(formData.myNumber).toBe(380);
+
+    const encodedFormData = encodeFormData(params);
+    expect(typeof encodedFormData).toBe("string");
+    expect(encodedFormData).toBe(
+      "myArray1=%2C%2C%2C%2C%2C%2C%2C&" +
+        "myArray2=1%2C2%2C4%2C16&" +
+        "myArray3=%5B%7B%22a%22%3A1%2C%22b%22%3A2%7D%2C%7B%22c%22%3A%22abc%22%7D%5D&" +
+        "myDate=1471417200000&" +
+        "myBoolean=true&" +
+        "myString=Hello%2C%20world!&" +
+        "myEmptyString=&" +
+        "myNumber=380"
+    );
+  });
+
+  it("should switch to form data if any item is not a basic type", () => {
+    const dateValue = 1471417200000;
+    const file = attachmentFile();
+    if (!file.name) {
+      // The file's name is used for adding files to a form, so supply a name when we're in a testing
+      // environment that doesn't support File (attachmentFile creates a File with the name "foo.txt"
+      // if File is supported and a file stream otherwise)
+      file.name = "foo.txt";
+    }
+
+    // null, undefined, function are excluded. If you want to send an empty key you need to send an empty string "".
+    // See https://github.com/Esri/arcgis-rest-js/issues/18
+    const params = {
+      myArray1: new Array(8),
+      myArray2: [1, 2, 4, 16],
+      myArray3: [{ a: 1, b: 2 }, { c: "abc" }],
+      myDate: new Date(dateValue),
+      myFunction: () => {
+        return 3.1415;
+      },
+      myBoolean: true,
+      myString: "Hello, world!",
+      myEmptyString: "",
+      myNumber: 380,
+      file
+    };
+
+    expect(requiresFormData(params)).toBeTruthy();
+
+    const formData = processParams(params);
+    expect(typeof formData).toBe("object");
+    expect(formData.myArray1).toBe(",,,,,,,");
+    expect(formData.myArray2).toBe("1,2,4,16");
+    expect(formData.myArray3).toBe('[{"a":1,"b":2},{"c":"abc"}]');
+    expect(formData.myDate).toBe(dateValue);
+    expect(formData.myBoolean).toBeTruthy();
+    expect(formData.myString).toBe("Hello, world!");
+    expect(formData.myEmptyString).toBe("");
+    expect(formData.myNumber).toBe(380);
+    expect(typeof formData.file).toBe("object");
+
+    const encodedFormData = encodeFormData(params);
+    expect(encodedFormData instanceof FormData).toBeTruthy();
+  });
+});

package/packages/arcgis-rest-request/test/utils/get-portal-url.test.ts

@@ -0,0 +1,34 @@
+import { getPortalUrl } from "../../src/index";
+
+describe("getPortalUrl", () => {
+  it("should default to arcgis.com", () => {
+    const url = getPortalUrl();
+    expect(url).toEqual("https://www.arcgis.com/sharing/rest");
+  });
+  it("should use the portal from authorization if passed", () => {
+    const requestOptions = {
+      authentication: {
+        portal: "https://foo.com/arcgis/sharing/rest",
+        getToken() {
+          return Promise.resolve("fake");
+        }
+      }
+    };
+    const url = getPortalUrl(requestOptions);
+    expect(url).toEqual("https://foo.com/arcgis/sharing/rest");
+  });
+
+  it("should use the portal in the requestOptions if passed", () => {
+    const requestOptions = {
+      authentication: {
+        portal: "https://foo.com/arcgis/sharing/rest",
+        getToken() {
+          return Promise.resolve("fake");
+        }
+      },
+      portal: "https://bar.com/arcgis/sharing/rest"
+    };
+    const url = getPortalUrl(requestOptions);
+    expect(url).toEqual("https://bar.com/arcgis/sharing/rest");
+  });
+});

package/packages/arcgis-rest-request/test/utils/portal.test.ts

@@ -0,0 +1,94 @@
+import { getSelf, getPortal } from "../../src/index";
+
+import { PortalResponse } from "./../mocks/portal";
+
+import * as fetchMock from "fetch-mock";
+
+describe("portal", () => {
+  let paramsSpy: jasmine.Spy;
+
+  beforeEach(() => {
+    paramsSpy = spyOn(FormData.prototype, "append").and.callThrough();
+  });
+
+  afterAll(() => {
+    paramsSpy.calls.reset();
+  });
+
+  afterEach(fetchMock.restore);
+
+  describe("getPortal", () => {
+    // setup an authmgr to use in all these tests
+    const MOCK_AUTH = {
+      getToken() {
+        return Promise.resolve("fake-token");
+      },
+      portal: "https://myorg.maps.arcgis.com/sharing/rest"
+    };
+    const MOCK_REQOPTS = {
+      authentication: MOCK_AUTH
+    };
+
+    it("should get the portal by id", done => {
+      fetchMock.once("*", PortalResponse);
+      getPortal("5BZFaKe", MOCK_REQOPTS)
+        .then(response => {
+          expect(fetchMock.called()).toEqual(true);
+          const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+          expect(url).toEqual(
+            "https://myorg.maps.arcgis.com/sharing/rest/portals/5BZFaKe?f=json&token=fake-token"
+          );
+          expect(options.method).toBe("GET");
+          done();
+        })
+        .catch(e => {
+          fail(e);
+        });
+    });
+    it("should get the portal self if no id", done => {
+      fetchMock.once("*", PortalResponse);
+      getPortal(null, MOCK_REQOPTS)
+        .then(response => {
+          expect(fetchMock.called()).toEqual(true);
+          const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+          expect(url).toEqual(
+            "https://myorg.maps.arcgis.com/sharing/rest/portals/self?f=json&token=fake-token"
+          );
+          expect(options.method).toBe("GET");
+          done();
+        })
+        .catch(e => {
+          fail(e);
+        });
+    });
+  });
+  describe("getSelf", () => {
+    // setup an authmgr to use in all these tests
+    const MOCK_AUTH = {
+      getToken() {
+        return Promise.resolve("fake-token");
+      },
+      portal: "https://myorg.maps.arcgis.com/sharing/rest"
+    };
+    const MOCK_REQOPTS = {
+      authentication: MOCK_AUTH
+    };
+
+    it("should get the portal by id", done => {
+      fetchMock.once("*", PortalResponse);
+      getSelf(MOCK_REQOPTS)
+        .then(response => {
+          expect(fetchMock.called()).toEqual(true);
+          const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+          expect(url).toEqual(
+            "https://myorg.maps.arcgis.com/sharing/rest/portals/self?f=json&token=fake-token"
+          );
+          expect(options.method).toBe("GET");
+          done();
+        })
+        .catch(e => {
+          fail(e);
+        });
+    });
+  });
+});

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

@@ -0,0 +1,190 @@
+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"
+          })
+        : new Buffer("");
+
+    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"
+          })
+        : new Buffer("");
+
+    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,55 @@
+{
+  "name": "@esri/arcgis-rest-sharing",
+  "version": "1.6.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.7.1"
+  },
+  "peerDependencies": {
+    "@esri/arcgis-rest-auth": "^1.5.1",
+    "@esri/arcgis-rest-common-types": "^1.5.1",
+    "@esri/arcgis-rest-request": "^1.5.1"
+  },
+  "devDependencies": {
+    "@esri/arcgis-rest-auth": "^1.6.0",
+    "@esri/arcgis-rest-common-types": "^1.6.0",
+    "@esri/arcgis-rest-request": "^1.6.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,91 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import {
+  request,
+  IRequestOptions,
+  getPortalUrl
+} from "@esri/arcgis-rest-request";
+
+import { UserSession } from "@esri/arcgis-rest-auth";
+
+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);
+}