aspernaturalias 1.0.0

package/packages/arcgis-rest-portal/test/util/SearchQueryBuilder.test.ts

@@ -0,0 +1,340 @@
+/* Copyright (c) 2019 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { SearchQueryBuilder } from "../../src/util/SearchQueryBuilder";
+
+describe("SearchQueryBuilder", () => {
+  const originalWarn = console.warn;
+
+  beforeAll(function() {
+    console.warn = jasmine.createSpy().and.callFake(() => {
+      return;
+    });
+  });
+
+  afterAll(function() {
+    console.warn = originalWarn;
+  });
+
+  it("should return an empty string when called with no other functions", () => {
+    const query = new SearchQueryBuilder().toParam();
+    expect(query).toEqual("");
+  });
+
+  it("should format a simple search query", () => {
+    const query = new SearchQueryBuilder().match("test").toParam();
+    expect(query).toEqual("test");
+  });
+
+  it("should format a simple search query in a field", () => {
+    const query = new SearchQueryBuilder()
+      .match("test")
+      .in("tags")
+      .toParam();
+    expect(query).toEqual("tags:test");
+  });
+
+  it("should warp multi word search terms in quotes", () => {
+    const query = new SearchQueryBuilder().match("foo bar").toParam();
+    expect(query).toEqual(`"foo bar"`);
+  });
+
+  it("should accept .in() without a parameter", () => {
+    const query = new SearchQueryBuilder()
+      .match("test")
+      .in()
+      .toParam();
+    expect(query).toEqual(`test`);
+  });
+
+  it("should accept `*` as a value for .in()", () => {
+    const query = new SearchQueryBuilder()
+      .match("test")
+      .in("*")
+      .toParam();
+    expect(query).toEqual(`test`);
+  });
+
+  it("should chain calls with .and()", () => {
+    const query = new SearchQueryBuilder()
+      .match("bar")
+      .and()
+      .match("foo")
+      .in("tags")
+      .toParam();
+
+    expect(query).toEqual("bar AND tags:foo");
+  });
+
+  it("should format a simple range", () => {
+    const query = new SearchQueryBuilder()
+      .from("a")
+      .to("z")
+      .in("title")
+      .toParam();
+    expect(query).toEqual("title:[a TO z]");
+  });
+
+  it("should format a simple group", () => {
+    const query = new SearchQueryBuilder()
+      .startGroup()
+      .from("a")
+      .to("z")
+      .in("title")
+      .endGroup()
+      .toParam();
+    expect(query).toEqual("(title:[a TO z])");
+  });
+
+  it("should format a more complex group", () => {
+    const query = new SearchQueryBuilder()
+      .startGroup()
+      .match("California")
+      .or()
+      .match("recent")
+      .endGroup()
+      .and()
+      .match("fires")
+      .toParam();
+    expect(query).toEqual("(California OR recent) AND fires");
+  });
+
+  it("should boost the previous search", () => {
+    const query = new SearchQueryBuilder()
+      .match("test")
+      .boost(5)
+      .toParam();
+    expect(query).toEqual("test^5");
+  });
+
+  it("should convert dates into timestamps", () => {
+    const date1 = new Date("January 1 2019");
+    const date2 = new Date("January 7 2019");
+    const expectedDate1 = date1.getTime();
+    const expectedDate2 = date2.getTime();
+
+    const query = new SearchQueryBuilder()
+      .from(date1)
+      .to(date2)
+      .in("created")
+      .and()
+      .match("test")
+      .in("tags")
+      .toParam();
+
+    expect(query).toEqual(
+      `created:[${expectedDate1} TO ${expectedDate2}] AND tags:test`
+    );
+  });
+
+  it("should format a complex group properly", () => {
+    const query = new SearchQueryBuilder()
+      .match("fred")
+      .in("owner")
+      .and()
+      .startGroup()
+      .match("Web Mapping Application")
+      .in("type")
+      .or()
+      .match("Mobile Application")
+      .in("type")
+      .or()
+      .match("Application")
+      .in("type")
+      .endGroup()
+      .and()
+      .match("test")
+      .in("*")
+      .toParam();
+
+    expect(query).toEqual(
+      `owner:fred AND (type:"Web Mapping Application" OR type:"Mobile Application" OR type:Application) AND test`
+    );
+  });
+
+  it("should allow .not to be called without a preceding search value", () => {
+    const query = new SearchQueryBuilder()
+      .not()
+      .match("public")
+      .in("access")
+      .not()
+      .match("code attachment")
+      .in("type")
+      .toParam();
+
+    expect(query).toEqual(`NOT access:public NOT type:"code attachment"`);
+  });
+
+  it("should clone searches for modification", () => {
+    const myAppsQuery = new SearchQueryBuilder()
+      .match("fred")
+      .in("owner")
+      .and()
+      .startGroup()
+      .match("Web Mapping Application")
+      .in("type")
+      .or()
+      .match("Mobile Application")
+      .in("type")
+      .or()
+      .match("Application")
+      .in("type")
+      .endGroup();
+
+    const myTestAppsQuery = myAppsQuery
+      .clone()
+      .and()
+      .match("test")
+      .in("*");
+
+    expect(myAppsQuery.toParam()).toEqual(
+      `owner:fred AND (type:"Web Mapping Application" OR type:"Mobile Application" OR type:Application)`
+    );
+
+    expect(myTestAppsQuery.toParam()).toEqual(
+      `owner:fred AND (type:"Web Mapping Application" OR type:"Mobile Application" OR type:Application) AND test`
+    );
+  });
+
+  it("should not allow trailing modifiers, and warn user", () => {
+    const query = new SearchQueryBuilder()
+      .match("test")
+      .not()
+      .toParam();
+
+    expect(console.warn).toHaveBeenCalled();
+    expect(query).toEqual("test");
+  });
+
+  it("should not allow chains of logic modifiers, and warn user", () => {
+    const query = new SearchQueryBuilder()
+      .and()
+      .or()
+      .or()
+      .toParam();
+
+    expect(console.warn).toHaveBeenCalled();
+    expect(query).toEqual("");
+  });
+
+  it("should not allow chains of logic modifiers after a .match, and warn user", () => {
+    const query = new SearchQueryBuilder()
+      .match("test")
+      .not()
+      .and()
+      .toParam();
+
+    expect(console.warn).toHaveBeenCalled();
+    expect(query).toEqual("test");
+  });
+
+  it("should close groups on toParam(), and warn user", () => {
+    const query = new SearchQueryBuilder()
+      .startGroup()
+      .match("test")
+      .toParam();
+
+    expect(console.warn).toHaveBeenCalled();
+    expect(query).toEqual("(test)");
+  });
+
+  it("should close groups automatically on clone(), and warn user", () => {
+    const query = new SearchQueryBuilder()
+      .startGroup()
+      .match("test")
+      .clone()
+      .toParam();
+
+    expect(console.warn).toHaveBeenCalled();
+    expect(query).toEqual("(test)");
+  });
+
+  it("should close more then 1 group, and warn user", () => {
+    const query = new SearchQueryBuilder()
+      .startGroup()
+      .match("foo")
+      .startGroup()
+      .match("bar")
+      .toParam();
+
+    expect(console.warn).toHaveBeenCalled();
+    expect(query).toEqual("(foo (bar))");
+  });
+
+  it("should not allow .in() without valid term or range and warn user", () => {
+    const query = new SearchQueryBuilder()
+      .in("tags")
+      .in("title")
+      .toParam();
+
+    expect(console.warn).toHaveBeenCalled();
+    expect(query).toEqual("");
+  });
+
+  it("should not allow .in() with only .from() and warn user", () => {
+    const query = new SearchQueryBuilder()
+      .from("a")
+      .in("title")
+      .toParam();
+
+    expect(console.warn).toHaveBeenCalled();
+    expect(query).toEqual("");
+  });
+
+  it("should not allow .in() with only .to() and warn user", () => {
+    const query = new SearchQueryBuilder()
+      .to("a")
+      .in("title")
+      .toParam();
+
+    expect(console.warn).toHaveBeenCalled();
+    expect(query).toEqual("");
+  });
+
+  it("should not allow .to() after a .match() and warn user", () => {
+    const query = new SearchQueryBuilder()
+      .match("test")
+      .to("a")
+      .toParam();
+
+    expect(console.warn).toHaveBeenCalled();
+    expect(query).toEqual("test");
+  });
+
+  it("should not allow .to() after a .match() and warn user", () => {
+    const query = new SearchQueryBuilder()
+      .match("test")
+      .from("a")
+      .toParam();
+
+    expect(console.warn).toHaveBeenCalled();
+    expect(query).toEqual("test");
+  });
+
+  it("should not allow .endGroup() without .startGroup()", () => {
+    const query = new SearchQueryBuilder()
+      .match("a")
+      .in("title")
+      .endGroup()
+      .toParam();
+
+    expect(console.warn).toHaveBeenCalled();
+    expect(query).toEqual("title:a");
+  });
+
+  it("should not allow .match().from().in(), and warn user", () => {
+    const query = new SearchQueryBuilder()
+      .match("test")
+      .from("a")
+      .in("title")
+      .toParam();
+
+    expect(console.warn).toHaveBeenCalled();
+    expect(query).toEqual("title:test");
+  });
+
+  it("should produce an empty string when no methods are called", () => {
+    const query = new SearchQueryBuilder().toParam();
+    expect(query).toEqual("");
+  });
+});

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

@@ -0,0 +1,37 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { getPortalUrl } from "../../src/util/get-portal-url";
+
+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-portal/test/util/portal.test.ts

@@ -0,0 +1,97 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { getSelf, getPortal } from "../../src/util/get-portal";
+
+import { PortalResponse } from "./../mocks/portal/response";
+
+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-portal/tsconfig.json

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

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

@@ -0,0 +1,72 @@
+[![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-request.svg?style=flat-square
+[npm-url]: https://www.npmjs.com/package/@esri/arcgis-rest-request
+[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-request/dist/umd/request.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-request
+
+> A module for making requests to the ArcGIS REST API that runs in Node.js and modern browsers.
+
+### Example
+
+```bash
+npm install @esri/arcgis-rest-request
+```
+
+```js
+import { request } from '@esri/arcgis-rest-request';
+
+const url = "https://www.arcgis.com/sharing/rest/content/items/6e03e8c26aad4b9c92a87c1063ddb0e3/data";
+
+request(url)
+    .then(response => {
+        console.log(response) // WebMap JSON
+    });
+```
+
+### [API Reference](https://esri.github.io/arcgis-rest-js/api/request/)
+
+### 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-request/package-lock.json

@@ -0,0 +1,11 @@
+{
+	"requires": true,
+	"lockfileVersion": 1,
+	"dependencies": {
+		"tslib": {
+			"version": "1.9.3",
+			"resolved": "https://registry.npmjs.org/tslib/-/tslib-1.9.3.tgz",
+			"integrity": "sha512-4krF8scpejhaOgqzBEcGM7yDIEfi0/8+8zDRZhNZZ2kjmHJ4hv3zCbQWxoJGz1iw5U0Jl0nma13xzHXcncMavQ=="
+		}
+	}
+}

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

@@ -0,0 +1,60 @@
+{
+  "name": "@esri/arcgis-rest-request",
+  "version": "2.0.4",
+  "description": "Common methods and utilities for @esri/arcgis-rest-js packages.",
+  "main": "dist/node/index.js",
+  "unpkg": "dist/umd/request.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",
+  "dependencies": {
+    "tslib": "^1.9.3"
+  },
+  "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",
+    "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-request"
+  },
+  "contributors": [
+    {
+      "name": "Patrick Arlt",
+      "email": "parlt@esri.com",
+      "url": "http://patrickarlt.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"
+  ],
+  "esri": {
+    "keyExports": [
+      "request"
+    ]
+  }
+}

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

@@ -0,0 +1,24 @@
+/* Copyright (c) 2018-2019 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+export * from "./request";
+export * from "./utils/append-custom-params";
+export * from "./utils/ArcGISRequestError";
+export * from "./utils/clean-url";
+export * from "./utils/encode-form-data";
+export * from "./utils/encode-query-string";
+export * from "./utils/ErrorTypes";
+export * from "./utils/GrantTypes";
+export * from "./utils/HTTPMethods";
+export * from "./utils/IAuthenticationManager";
+export * from "./utils/IFetchTokenParams";
+export * from "./utils/IGenerateTokenParams";
+export * from "./utils/IParams";
+export * from "./utils/IParamBuilder";
+export * from "./utils/IParamsBuilder";
+export * from "./utils/IRequestOptions";
+export * from "./utils/ITokenRequestOptions";
+export * from "./utils/process-params";
+export * from "./utils/ResponseFormats";
+export * from "./utils/retryAuthError";
+export * from "./utils/warn";