aspernaturalias 1.0.0

package/packages/arcgis-rest-auth/test/fetchToken.test.ts

@@ -0,0 +1,112 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import * as fetchMock from "fetch-mock";
+import { fetchToken } from "../src/index";
+
+const TOKEN_URL = "https://www.arcgis.com/sharing/rest/oauth2/token";
+
+describe("fetchToken()", () => {
+  afterEach(fetchMock.restore);
+
+  it("should request a token with `client_credentials`, `client_id` and `client_secret`", done => {
+    fetchMock.postOnce(TOKEN_URL, {
+      access_token: "token",
+      expires_in: 1800,
+      ssl: true
+    });
+
+    fetchToken(TOKEN_URL, {
+      params: {
+        client_id: "clientId",
+        client_secret: "clientSecret",
+        grant_type: "client_credentials"
+      }
+    })
+      .then(response => {
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall(
+          TOKEN_URL
+        );
+        expect(url).toEqual(TOKEN_URL);
+        expect(options.body).toContain("f=json");
+        expect(options.body).toContain("client_id=clientId");
+        expect(options.body).toContain("client_secret=clientSecret");
+        expect(options.body).toContain("grant_type=client_credentials");
+        expect(response.token).toEqual("token");
+        expect(response.expires).toBeGreaterThan(Date.now());
+        expect(response.ssl).toEqual(true);
+        done();
+      })
+      .catch(e => {
+        fail(e);
+      });
+  });
+
+  it("should request a token with `authorization_code`, `client_id` and `redirect_uri`", done => {
+    fetchMock.postOnce(TOKEN_URL, {
+      access_token: "token",
+      expires_in: 1800,
+      refresh_token: "refreshToken",
+      username: "Casey",
+      ssl: true
+    });
+
+    fetchToken(TOKEN_URL, {
+      params: {
+        client_id: "clientId",
+        redirect_uri: "https://example-app.com/redirect-uri",
+        code: "authorizationCode",
+        grant_type: "authorization_code"
+      }
+    })
+      .then(response => {
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall(
+          TOKEN_URL
+        );
+        expect(url).toEqual(TOKEN_URL);
+        expect(options.body).toContain("f=json");
+        expect(options.body).toContain("client_id=clientId");
+        expect(options.body).toContain(
+          `redirect_uri=${encodeURIComponent(
+            "https://example-app.com/redirect-uri"
+          )}`
+        );
+        expect(options.body).toContain("grant_type=authorization_code");
+        expect(options.body).toContain("code=authorizationCode");
+        expect(response.token).toEqual("token");
+        expect(response.refreshToken).toEqual("refreshToken");
+        expect(response.username).toEqual("Casey");
+        expect(response.expires).toBeGreaterThan(Date.now());
+        expect(response.ssl).toEqual(true);
+        done();
+      })
+      .catch(e => {
+        fail(e);
+      });
+  });
+
+  it("should return ssl: false when there is no ssl property returned from endpoint response", done => {
+    fetchMock.postOnce(TOKEN_URL, {
+      access_token: "token",
+      expires_in: 1800,
+      refresh_token: "refreshToken",
+      username: "Casey"
+    });
+
+    fetchToken(TOKEN_URL, {
+      params: {
+        client_id: "clientId",
+        redirect_uri: "https://example-app.com/redirect-uri",
+        code: "authorizationCode",
+        grant_type: "authorization_code"
+      }
+    })
+      .then(response => {
+        expect(response.ssl).toEqual(false);
+        done();
+      })
+      .catch(e => {
+        fail(e);
+      });
+  });
+});

package/packages/arcgis-rest-auth/test/generateToken.test.ts

@@ -0,0 +1,102 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import * as fetchMock from "fetch-mock";
+import { generateToken } from "../src/index";
+import { TOMORROW } from "./utils";
+
+const TOKEN_URL = "https://www.arcgis.com/sharing/rest/generateToken";
+
+describe("generateToken()", () => {
+  afterEach(fetchMock.restore);
+
+  it("should generate a token for a username and password", done => {
+    fetchMock.postOnce(TOKEN_URL, {
+      token: "token",
+      expires: TOMORROW.getTime()
+    });
+
+    generateToken(TOKEN_URL, {
+      params: {
+        username: "Casey",
+        password: "Jones"
+      }
+    })
+      .then(response => {
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall(
+          TOKEN_URL
+        );
+        expect(url).toEqual(TOKEN_URL);
+        expect(options.body).toContain("f=json");
+        expect(options.body).toContain("username=Casey");
+        expect(options.body).toContain("password=Jones");
+        expect(response.token).toEqual("token");
+        expect(response.expires).toEqual(TOMORROW.getTime());
+        done();
+      })
+      .catch(e => {
+        fail(e);
+      });
+  });
+});
+
+describe("generateToken() with custom fetch", () => {
+  const oldPromise = Promise;
+  const oldFetch = fetch;
+  const oldFormData = FormData;
+
+  beforeEach(() => {
+    Promise = undefined;
+    FormData = undefined;
+    Function("return this")().fetch = undefined;
+  });
+
+  afterEach(() => {
+    Promise = oldPromise;
+    FormData = oldFormData;
+    Function("return this")().fetch = oldFetch;
+  });
+
+  it("should generate a token for a username and password with custom fetch", done => {
+    Promise = oldPromise;
+    FormData = oldFormData;
+
+    const tokenResponse = {
+      token: "token",
+      expires: TOMORROW.getTime()
+    };
+
+    const MockFetchResponse = {
+      ok: true,
+      json() {
+        return Promise.resolve(tokenResponse);
+      },
+      blob() {
+        return Promise.resolve(new Blob([JSON.stringify(tokenResponse)]));
+      },
+      text() {
+        return Promise.resolve(JSON.stringify(tokenResponse));
+      }
+    };
+
+    const MockFetch = function() {
+      return Promise.resolve(MockFetchResponse);
+    };
+
+    generateToken(TOKEN_URL, {
+      params: {
+        username: "Casey",
+        password: "Jones"
+      },
+      fetch: MockFetch as any
+    })
+      .then(response => {
+        expect(response.token).toEqual(tokenResponse.token);
+        expect(response.expires).toEqual(tokenResponse.expires);
+        done();
+      })
+      .catch(e => {
+        fail(e);
+      });
+  });
+});

package/packages/arcgis-rest-auth/test/utils.ts

@@ -0,0 +1,14 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+export const TOMORROW = (function() {
+  const now = new Date();
+  now.setDate(now.getDate() + 1);
+  return now;
+})();
+
+export const YESTERDAY = (function() {
+  const now = new Date();
+  now.setDate(now.getDate() - 1);
+  return now;
+})();

package/packages/arcgis-rest-auth/tsconfig.json

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

package/packages/arcgis-rest-feature-layer/README.md

@@ -0,0 +1,77 @@
+[![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-feature-layer.svg?style=flat-square
+[npm-url]: https://www.npmjs.com/package/@esri/arcgis-rest-feature-layer
+[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-feature-layer/dist/umd/feature-layer.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-feature-layer
+
+> A module for querying and editing features in ArcGIS feature layers that runs in Node.js and modern browsers.
+
+### Example
+
+```bash
+npm install @esri/arcgis-rest-request
+npm install @esri/arcgis-rest-feature-layer
+```
+
+```js
+import { queryFeatures } from '@esri/arcgis-rest-feature-layer';
+
+const options = {
+  url:
+    "https://services.arcgis.com/V6ZHFr6zdgNZuVG0/arcgis/rest/services/Landscape_Trees/FeatureServer/0",
+  where: "Species = 'Oak'"
+};
+
+queryFeatures(options)
+  .then(response => {
+    console.log(response.features.length); // 500
+  });
+```
+
+### [API Reference](https://esri.github.io/arcgis-rest-js/api/feature-service/)
+
+### 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-feature-layer/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-feature-layer/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "@esri/arcgis-rest-feature-layer",
+  "version": "2.0.4",
+  "description": "Feature layer query and edit helpers for @esri/arcgis-rest-js",
+  "main": "dist/node/index.js",
+  "unpkg": "dist/umd/feature-layer.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",
+  "files": [
+    "dist/**"
+  ],
+  "dependencies": {
+    "@esri/arcgis-rest-types": "^2.0.4",
+    "tslib": "^1.9.3"
+  },
+  "devDependencies": {
+    "@esri/arcgis-rest-auth": "^2.0.4",
+    "@esri/arcgis-rest-request": "^2.0.4"
+  },
+  "peerDependencies": {
+    "@esri/arcgis-rest-auth": "^2.0.0",
+    "@esri/arcgis-rest-request": "^2.0.0"
+  },
+  "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-feature-layer"
+  },
+  "contributors": [
+    {
+      "name": "Tom Wayson",
+      "email": "twayson@esri.com",
+      "url": "http://tomwayson.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"
+  ]
+}

package/packages/arcgis-rest-feature-layer/src/add.ts

@@ -0,0 +1,56 @@
+/* Copyright (c) 2017 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import {
+  request,
+  cleanUrl,
+  appendCustomParams
+} from "@esri/arcgis-rest-request";
+
+import { IFeature } from "@esri/arcgis-rest-types";
+
+import { ISharedEditOptions, IEditFeatureResult } from "./helpers";
+
+/**
+ * Add features request options. See the [REST Documentation](https://developers.arcgis.com/rest/services-reference/add-features.htm) for more information.
+ *
+ */
+export interface IAddFeaturesOptions extends ISharedEditOptions {
+  /**
+   * Array of JSON features to add.
+   */
+  features: IFeature[];
+}
+
+/**
+ * ```js
+ * import { addFeatures } from '@esri/arcgis-rest-feature-layer';
+ * //
+ * addFeatures({
+ *   url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/ServiceRequest/FeatureServer/0",
+ *   features: [{
+ *     geometry: { x: -120, y: 45, spatialReference: { wkid: 4326 } },
+ *     attributes: { status: "alive" }
+ *   }]
+ * })
+ *   .then(response)
+ * ```
+ * Add features request. See the [REST Documentation](https://developers.arcgis.com/rest/services-reference/add-features.htm) for more information.
+ *
+ * @param requestOptions - Options for the request.
+ * @returns A Promise that will resolve with the addFeatures response.
+ */
+export function addFeatures(
+  requestOptions: IAddFeaturesOptions
+): Promise<{ addResults: IEditFeatureResult[] }> {
+  const url = `${cleanUrl(requestOptions.url)}/addFeatures`;
+
+  // edit operations are POST only
+  const options = appendCustomParams<IAddFeaturesOptions>(
+    requestOptions,
+    ["features", "gdbVersion", "returnEditMoment", "rollbackOnFailure"],
+    { params: { ...requestOptions.params } }
+  );
+
+  return request(url, options);
+}

package/packages/arcgis-rest-feature-layer/src/addAttachment.ts

@@ -0,0 +1,53 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { request, cleanUrl } from "@esri/arcgis-rest-request";
+import { IGetLayerOptions, IEditFeatureResult } from "./helpers";
+
+/**
+ * Request options for adding a related attachment to a feature by id. See [Add Attachment](https://developers.arcgis.com/rest/services-reference/add-attachment.htm) for more information.
+ *
+ */
+export interface IAddAttachmentOptions extends IGetLayerOptions {
+  /**
+   * Unique identifier of feature to add related attachment.
+   */
+  featureId: number;
+  /**
+   * File to be attached.
+   */
+  attachment: File;
+}
+
+/**
+ * ```js
+ * import { addAttachment } from '@esri/arcgis-rest-feature-layer';
+ * //
+ * addAttachment({
+ *   url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/ServiceRequest/FeatureServer/0",
+ *   featureId: 8484,
+ *   attachment: myFileInput.files[0]
+ * })
+ *   .then(response)
+ * ```
+ * Attach a file to a feature by id. See [Add Attachment](https://developers.arcgis.com/rest/services-reference/add-attachment.htm) for more information.
+ *
+ * @param requestOptions - Options for the request.
+ * @returns A Promise that will resolve with the `addAttachment()` response.
+ */
+export function addAttachment(
+  requestOptions: IAddAttachmentOptions
+): Promise<{ addAttachmentResult: IEditFeatureResult }> {
+  const options: IAddAttachmentOptions = {
+    params: {},
+    ...requestOptions
+  };
+
+  // `attachment` --> params: {}
+  options.params.attachment = requestOptions.attachment;
+
+  return request(
+    `${cleanUrl(options.url)}/${options.featureId}/addAttachment`,
+    options
+  );
+}

package/packages/arcgis-rest-feature-layer/src/decodeValues.ts

@@ -0,0 +1,124 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+import { IField, IFeature, ILayerDefinition } from "@esri/arcgis-rest-types";
+
+import { IQueryFeaturesResponse } from "./query";
+import { getLayer } from "./getLayer";
+
+/**
+ * Request options to fetch a feature by id.
+ */
+export interface IDecodeValuesOptions extends IRequestOptions {
+  /**
+   * Layer service url.
+   */
+  url?: string;
+  /**
+   * Unique identifier of the feature.
+   */
+  queryResponse: IQueryFeaturesResponse;
+  /**
+   * * If a fieldset is provided, no internal metadata check will be issued to gather info about coded value domains.
+   *
+   * getFeatureService(url)
+   *   .then(metadata => {
+   *     queryFeatures({ url })
+   *       .then(response => {
+   *         decodeValues({
+   *           url,
+   *           queryResponse,
+   *           fields: metadata.fields
+   *         })
+   *           .then(decodedResponse)
+   *       })
+   *   })
+   */
+  fields?: IField[];
+}
+
+/**
+ * ```js
+ * import { queryFeatures, decodeValues } from '@esri/arcgis-rest-feature-layer';
+ * //
+ * const url = `https://sampleserver6.arcgisonline.com/arcgis/rest/services/ServiceRequest/FeatureServer/0`
+ * queryFeatures({ url })
+ *   .then(queryResponse => {
+ *     decodeValues({
+ *       url,
+ *       queryResponse
+ *     })
+ *       .then(decodedResponse)
+ *   })
+ * ```
+ * Replaces the raw coded domain values in a query response with descriptions (for legibility).
+ *
+ * @param requestOptions - Options for the request.
+ * @returns A Promise that will resolve with the addFeatures response.
+ */
+export function decodeValues(
+  requestOptions: IDecodeValuesOptions
+): Promise<IQueryFeaturesResponse> {
+  return new Promise(resolve => {
+    if (!requestOptions.fields) {
+      return getLayer({ url: requestOptions.url }).then(
+        (metadata: ILayerDefinition) => {
+          resolve((requestOptions.fields = metadata.fields));
+        }
+      );
+    } else {
+      resolve(requestOptions.fields);
+    }
+  }).then(fields => {
+    // extract coded value domains
+    const domains = extractCodedValueDomains(fields as IField[]);
+    if (Object.keys(domains).length < 1) {
+      // no values to decode
+      return requestOptions.queryResponse;
+    }
+
+    // don't mutate original features
+    const decodedFeatures = requestOptions.queryResponse.features.map(
+      (feature: IFeature) => {
+        const decodedAttributes: { [index: string]: any } = {};
+        for (const key in feature.attributes) {
+          /* istanbul ignore next */
+          if (!feature.attributes.hasOwnProperty(key)) continue;
+          const value = feature.attributes[key];
+          const domain = domains[key];
+          decodedAttributes[key] =
+            value !== null && domain ? decodeValue(value, domain) : value;
+        }
+        // merge decoded attributes into the feature
+        return { ...feature, ...{ attributes: decodedAttributes } };
+      }
+    );
+    // merge decoded features into the response
+    return {
+      ...requestOptions.queryResponse,
+      ...{ features: decodedFeatures }
+    };
+  });
+}
+
+function extractCodedValueDomains(fields: IField[]) {
+  return fields.reduce(
+    (domains, field) => {
+      const domain = field.domain;
+      if (domain && domain.type === "codedValue") {
+        domains[field.name] = domain;
+      }
+      return domains;
+    },
+    {} as { [index: string]: any }
+  );
+}
+
+// TODO: add type for domain?
+function decodeValue(value: any, domain: any) {
+  const codedValue = domain.codedValues.find((d: any) => {
+    return value === d.code;
+  });
+  return codedValue ? codedValue.name : value;
+}

package/packages/arcgis-rest-feature-layer/src/delete.ts

@@ -0,0 +1,61 @@
+/* Copyright (c) 2017 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import {
+  request,
+  cleanUrl,
+  appendCustomParams
+} from "@esri/arcgis-rest-request";
+import {
+  ISharedEditOptions,
+  IEditFeatureResult,
+  ISharedQueryOptions
+} from "./helpers";
+
+/**
+ * Delete features request options. See the [REST Documentation](https://developers.arcgis.com/rest/services-reference/delete-features.htm) for more information.
+ *
+ */
+export interface IDeleteFeaturesOptions
+  extends ISharedEditOptions,
+    ISharedQueryOptions {
+  /**
+   * Array of objectIds to delete.
+   */
+  objectIds: number[];
+}
+
+/**
+ * ```js
+ * import { deleteFeatures } from '@esri/arcgis-rest-feature-layer';
+ * //
+ * deleteFeatures({
+ *   url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/ServiceRequest/FeatureServer/0",
+ *   objectIds: [1,2,3]
+ * });
+ * ```
+ * Delete features request. See the [REST Documentation](https://developers.arcgis.com/rest/services-reference/delete-features.htm) for more information.
+ *
+ * @param deleteFeaturesRequestOptions - Options for the request.
+ * @returns A Promise that will resolve with the deleteFeatures response.
+ */
+export function deleteFeatures(
+  requestOptions: IDeleteFeaturesOptions
+): Promise<{ deleteResults: IEditFeatureResult[] }> {
+  const url = `${cleanUrl(requestOptions.url)}/deleteFeatures`;
+
+  // edit operations POST only
+  const options = appendCustomParams<IDeleteFeaturesOptions>(
+    requestOptions,
+    [
+      "where",
+      "objectIds",
+      "gdbVersion",
+      "returnEditMoment",
+      "rollbackOnFailure"
+    ],
+    { params: { ...requestOptions.params } }
+  );
+
+  return request(url, options);
+}